diff --git a/docs/assets/dmt/dmt-component-data.js b/docs/assets/dmt/dmt-component-data.js index 96d743c..2728690 100644 --- a/docs/assets/dmt/dmt-component-data.js +++ b/docs/assets/dmt/dmt-component-data.js @@ -1 +1 @@ -globalThis.dmtComponentDataBCMP = 'xX1Zb2TXkSbb4wGMfurBYDDAANNdVnmVVHtJKsktq1gsUkWpWEUzWaWBMQBxmXlJXlUyM51Llegn/4SetWdpzMAWySJZm/bN3TbQ/dr207wYaPi3TJx9uWeJuEmqH2xJzPjiO2vcc+LEifPHmT89rNr93s2qd2/0x5lvPByVw/tVu/wvf5z5Fw872+PlYrz1JRMYnZO/nOtUo3Z/2Dk76G3ujatxt3x8Xfzl1NxWMX5/Muz+7dZ4PBi9du7ceGew1e+9Ozpb9RXsnKX4C1fxZjXemqwbvY/erMY3JuunVspBn6n9w4tKr5Rs97c1xZmN++PxmW61fm446Y2r7dLi+dTl6Q22LZJby0unlov2vWKz5CSXFcmDBw/OgiiUnvEMhMi5qw6hItudgPK/OhyAxGKvU74HLXm4VZXDYtje2nmq/+3s1ni7+3C735l0y9Fj+U/+x2fiPxZHsij/8KxX3K82i3HV7ymNB9vF8F6n/6D3V/uj/mTIO+kbu+PyvfHBaVmOg/ZW1e0My95/Uz/tdopxof/8X9Wf99r9bn+o//6f/jjzL/nf9/nfO7sDaLY/fF+W8NyaVL/GlK1xEfH/HV743XtVr/ONvXa3GI3+38yM1vpPM/9G652z9J7lkmm9Qt6o/8df1PXDvwfLfXFj0muzlksyiH+cuWA4rqYp4H9lT1KcR1EIBJbgcLMcL/SH28VYcFxCcWgQuh7Dotfpb1PqIRBYgoObxTrvPlmNqjcuhxtFO93hCmRYfvcnMxme9lYDHgki8PyHnZ/TeRSIwDPb27F4zoKlSVMoeUPx+5lTM2mSwxujbmGxMAOaZtEACs0BoEh1UfLEutyn1kUCiHW5T6yLkKfV5cE6sS4KQKvLA3tuIuoi5Ul1gblMq4sG0GjaW0QaBaDQ7C93J5tVT3C8mOUQ0qR6rGwSm0sDSF0PKFLXK3lSXcDs0eqiAaS6wJJsMCxHI8FyOrZQEUKZRcpPldYns6OdXnvOUX0htlaRqh0IernyjMOul241LmG4DAjN9lgCN7rFuJTffRwVR6B5HnHUm5Pez6uB7H4MjQAQa7PYo9ZGItA8H3LUHVY2h+wlDJkNI7YfQGEbQ2g/ASCOvZ9WA2dAoMaeAaHZDgVQ1+gMiodSnwN3wr6YISDP1SM24zrlndWFK5nti1Rs5Gkcdi0wHMR6PHT6+4UsAa2fj+Z7tFYy8vhNnm1ans/oJ1qVh84cz7UOdWbvcXsgdP8wo5uL4q1h3UDlrGEj2/QBRy2DwOrWsD/Z3BJclzFcFgrf17YZzPU10QK+D3ZMejgyikEQPwN8k5qbAQ2s6VPA1PrgYp6nSQ/sGqP9gxwDyV67li7hgZDa1b/gXTWPFaQFH5OsT8ijYRgs0VHHs9t5GoPA1+epAZkaXSZQUer0sGMP4nMIFi6Or80jiTBVuYAlodRjf9P6WpzNMghpfC2OBMBUIj+QDQLdF5Vt2PN9IcUJfSERlL6wIGjX5mg8XBj2t+/IxUG+JhqAbipArPYVwRkMARPHqt+zBlNeOXEsHXpDKd885JG0Dwhtz/OzQUgTZoMAUGaDQWBJ3tc98EJWO6n9Hzqtn+9eYtvvmpZ/Ma+b1O4HbqvnO5ba5h/bnoDbA65bcL2W8IMHvAgSi3eHf2Q5BxziV5HEDhTP+4EA+6yvYFmbcIpWlmvyRq3sYvHMwhuwWg63q16x3pVfmpeRrAaHZ7T8Kk5NryA5bSR1NImNQqPR5ECp7QtLcIcU274Gh2cUXkxADkx/XsbzcRR1trANQKPZYgHxnE9D5uilPGNTS3S0wGDzw6Hyal/IcxkIoecCxg7Rcw3t3McC1xoPy2KbanMCWDzzo5pxvYhgbFLHpyGTihgpTa3pJxIYaNQfoVkbtqrwBAnnI+Ko2nbQSBCe63MbNgfFHA8n7bGaHj+m0Vp4fAkOuYaFSlm480hOhiDMSI2BvumjZ6SDovagM2qwPUgeLQccNihlPMs5JA8AaK3nfxhwrdfkq/CxwDWzZwEsoZ7w2Zwdj4fV+mRc4uvpoAijBHCLvcFkbAY/YpTYIMKXz1+4IL58TdYsB+5yBTEa6SuVR7VFCuKr02h9Is682AdLbigRx9OnDUYcgV/NHIHvbmr9P8Do5+JI1aboz2NUM/EzF5DKD1hBzI71RWzZOQRH8RlvS74Cuz4sqt4NCF/rqm/ilXBEgr0orSEpoQmfGxXCnDjsryLZHSiFXuyu1OywTESe2AZRKJ/wEs8V3e46BK8m4z7sxbECUKg+irXr5Txf4yaVC+Wlcnu9HDqsLyVZAzASLRS46m0GKpumDcBIvcm/85TedAAUqmd6nQT/A0ssPzF5MgOh0IkjTIZ1WvMijq9BU7IvtTcNI1FX3keNOgOfmt3mHKyo5ZS4Xwwrpg2xR2UoQ3gqQiZCx/c3eLixHWouXczrxah8+XLymySwa0ISGzy+W4z7KiAm5uB0FTMA+rCQCS/3uzsbVbcrvRd4FgVE+4LXx/2CVBcGQNeFCTeqiw2k1GVCrcukph0OUWE8tmEsdoInF+wYUw3q6OmUyyMg+Mh+HotCYhAQ9AGPEL+zspg5uw2RAAp9UCxuHFybgHGstIcTSeZA0SNOwMRHhzTibCCW7QMBugML9yuzw2GxI30rFEYDRrfqBjuJ9DiRrepC8ee+o7tFt8rdZ3GpJAbdc+O+Xydkz9lAtK2YUG04A1BthZ5nN2XLYb9Cpw0Qt8c4Yh17zfrgXUJTWUjklmnct5kuoJk0Dsez77DElg8uj4Dk1w5yXN8vhyPoedk7OAqJQXPcnV9pLd6+lVkFuRwSYx+8SpbMiNt7d9TvvZS8LyeZuGByyfOftdK3WrdvSaVxx6ajlyMIxzbC7lYbO+65VGh56vD4OMoylbeV3Pfn28o6og4uD/9CT8ViMOjuzHeqsfK9ZQyM0G5QWBv2pA17KthItoteT+0eciZTcDlALN1HGyByC6zS7PhmHwagnjd/ieKso9FfWQO9vbExKuV9xNeItAKLXoQJLZnoEZeKdO/xEdyUdNvxJRSLBaNQsTZgl4+JVAqG/opLDHz6J+rwnsLFceg+gkkLU5/SRwKBjrIaFMNRLtrN0c8B6GU4l14dlsophqdgIHTMzABsJNw8B5i3J38dR1iHo00UnKSBM6a/vV32lDnEmSgHiO6v+9WoknMW118cgF40MvOcOxJw1DMAIRRF3JyG/c6m8xn8SxxZDU04jGDfa+dDEg8JcTgtHJHtLmt5dURLYJM4yr1sx8rGD6ccqrqNzR74LTHbUgmY03/xA2iHMoDHs+8y60kamwxAOHozBiAXtuCwGBjhSJGDkAE8dTZy2+2tFL3N7MG9Q8QRhMCPkPW9XPYm28jGc43ut9KfFTYhrZ46l+XRACzFERx/jYv33gZB2Wx5Do1AkzDruVKOJl21DMtsB4S9FQjS9V1mV8ziKOgUr9khd1WEIGHzbRU0Y0mUPIXkYavcZF9MedCb5ZDiJIrt0SbLPiMofpjcN0nRzM7p30au4qS9JVI37lY1JJqRewl5W2AWHG89U435zGKhRuarQa/FfOA15eC4MW0RQBPag8jkAejcD5ujFsBVguX+0IXp+i9MR0+oPdw8tYLSIjfqvRFcC0nL3d8U90lJHBKCv8XJkjMpG49i4AC0/kdcXJzcJu+ah1gEDN9eYgyT2ktC0BxwlMwBdo1eoTAR6/S46HTmmY/fuBiv4Ab5WRuJ3uW3u2UxbPFUXLidlmKzgOitt30KljsQUDxTHINhKWjnYKBbfQFy7gNFQDH2j+GGa6+z0O0X40sXaQPARhLuVJn6YBtMYNAfDiG+BAusaqCCCHKOOJdKYdHWGhmv6ZHRb0Ys3Lw9u3rp4trt5VVwvbfkFEqsaxWVB8Qub6U5cmPBEys21xg18Hf/au6CXHtmDiEU01z9+CGi+tfV6BbsW++Xs+12CWEpfA87z2/iyA3Cm0jOhCJsYT5emW/Nr9ydX2utzq6srrWWZ+fmRSHeQBYioABL/iHDrq5du7OwML+ytnT7uqR+nUDtwAnEd1rz0xB7cPQB16QHCS2VoU5vCKQo7tjpg81hMdgqt8tFmPIQ3CIXB7njBsXho9E+SwVsDbrK3Zc7Xfc5OTRPKCOYxHUD/ZPOo7nXLtpbJommzop5+LNJ1b53pjuU0S6RE1ihdo0rWeOQNYDg2v7gJ0z+5sodaeLDy6QIg8LiV3+urydkBCNUJDMoU5BuFaOteqPuFSbwIBIFLMvA8GtcOtmW/93k0gOAFdbwcrIxLe0ah1/iasidcSUjrtJ9F6JjWHz+Jji54ac27H7826Ws449jE6ZO6+HRp4K6uO69psTgCdW1wXf0fV3LoBOnTubUCpG0DuQXqrLbUWseNItAUSbD/giW/u3AdNiF8xdp0iP3BWQJhII1Jp6cDn+jJ9rPJuVQNmAkSqWuGqY8gHC269kqAFoc+xNDNZecBnUqTwl6PnzmAZ3ReSPRldkiNBiqR0aF3H9gW8EipyR/ggKulJ1JW3k+0sbH5rOx+KR4ppQO7bXoNiFZ0xp9dtMQNH6vkybMaV8HLjrKWKH0579Gh6fwDdErZCKJRsaVsY4wx1gps+d3n3uWhbiWYvrcmZ+vEzgdOIX809qAuw40ogCz5AJYKiiF+KqmAc5NyrEpyULTkmg9DYvTmqyP2nAN0b0WQS+Or4e0RoRFvfko6tODw83uGfhlWL0nCvWd2oRguLXNLvsnSGUOPv61/tguFWPpIKqn4/NUMlG8i5hJyx14PWtdQDM+xT0r8yV8mS+RFMszAYxiy+2fU/yTiQroyipmovhWZtKy/7KtzGXxZb5btrEjg4mSFGO7j4mSFGO7j4miFUPaC3CHWvso/3jTU27ESYtvPgtuVvfkV8jPsB2aM0yadBTMUIbihTxFE4ZLFAYuTGW4TGHgwqSe4DMF3RNamlQLhkLXQgmTGNisRDMoYSoDvq+VMJUB39dKmMIAef9gvT7om9Po74U/rZZc8uMKPjRpjuDLn8iTV1PKxNGH+YsGuCB1y3VkaP9R4wrACTlPAuhbBbz9I5ykoT7KcDM0KRJksLUzqtpy6fxcuMOkTLKztNPhg9W3WnfLbr9djXdWh/osq54M3FHtg/Cfqolykv02XHj2Oy6u5Ags3BYEhemXbCLrAK7RyOKXGPDjtsoSHBvHXDkXROfr65Sbq/2VQi0Rk5qVLFr5sOis9q+X8h5eWrmSRTvNB/xhi/oYerhd9ODFKrltqK/QBQ6YuVSyd/+vrkl5H6Kk1idyqNcdYq7SNSWe1P4/tfZ5R3vdPRzTrnB497BCLA/776nLimQ6DsbniFawVtmeDJV5IpMKNJ2V/1Ml3vGMYo5TYEl+Bbe4t9ffDfsVcLUFOGnBxNFmB+8fJidJqRt2MWiXCmmTfGdNkgtQFKrHHOQmZ6TQNXDRPLOBtydy1+ifLWBYAUwaQOK9nsXe/f69kuvBGQX5zo+FQ0+Vj21oazIY9IeStO4sTpBKJN4WCfCSba3rqeODhBKD90uXo3YxKFeLIbha41dtPC4bhD47lpeeIYfcRiW/e6Hrfx6Vg8JyfSEaQ7Z7Levd1dASNNicdQ2EKyuOisXtgTx0DKYxTbEzKCGxITNXMLWECifQxD899khDQMoE/dhVYH1d/MuqSWLyl8Wt8Uq53b/fpMYSSDK/AmkPaT8BT7Bj/dGMOK0SQPMF8z08QR7ql+uZ1QWGyk+7E6Rq9KX8xDFayUiHlLVrEOmwP7pfQlYi/dP/0D8U3CDZR6fih/dhT6L/qjPp7G302/G1ryBZEyrXQAEExYA4bsd3WI0WmLQay6FAmxiBhmIt5l7FUg7i68HFcW6Go3vlDsQCPSjUo6+hoMgYg8GiY32h2qtVbweQKu6BwGeBsYTP7hiMmTT+gihG6IFJ68z+OnsoWa0QziO6TSFw0QJP4TJB9XNYa9s0s6jW1ESuCnQwbZCZUkFXgZ0t4puJOfdoMoDTM0h4B6FUgvT2NNUFWksh+oWGwbA/KIfjSmUord/2qZfAYJB9y5MqtNrDfrc77sutSuieS5LKVYJeCo77m5vd8no5LqqurOM1KrWjA23mRuMdFZuNMXNcHGeuH4m2YACS3REUFpiQp0fFsdVTuLk8WWedHhZPOju9Yrtqz1oe21BgfkC/g8RW4pPrNioZrhagDIFJbtqiV4GfTQ6IukNMUQopXAvubo7Uzr8e8OsqXGOiuMgw6dPLWXpLr1wx4Qbv3nq/p51sBO1rHJfkcLLJA5K96thXmSPqt6ZCLWTB8HvozrDY3GR7GIbOr6BsPgeKvrwHe2EmP1+MIM0AOziIJ5IIkdbg6Lst9lxFDY2z/hwNfBK1+/5LSK9rWkNOshbshGUXLoW2swnSqDrKFjegQ37BIkYDWRBShluGW4TsDuOqcMrgByolylBXQUqTyuCrD8rSNZxv0PhtBSTj6czkeqRdiLY2iwMjT28cDljpzIrad2ym9CskLXkwgJb7kELD/xJhBpXN7Ckh7fN5j1jeON8xn+P2nXKINMIhS4nqTQeIXWI/7DtN28QkA5VUgrWRn7mm1T0Q/jGiicN48vASKlbKjRJ+VHdRYwudML8GU8itRcn5wKWn4PfI+fal7zk9ZcL+h+81AlHoq4emvFmN1GQhUzIslvKJ1GF7NkMebG/V6KDQXgy2IZAJb3JrfCOZCar8V3qt0uLQWZ+jHpIe4Khh8S+MQzjC9aro9qWvtH6mEaDTGPwDyFbZWmO9vA+migoQ+mjKq1DlWLSO+WoFvf0BVgdKyJ4jQCsl2xbdV7eOkZwullBP3Sf0ejpQwpLP75W8py3RpWS/+BLcOYe0oqCntVWqfN3+qUaA2MOROPmiGJDJtJ+hXnVxFM6nHHtnMXnxOkapYRTGL2rWBLWUTZmjJqsuf9b6LxtEeakj6SN3zlnzB8toQ0nrDz3zrk3G4751lBRbYoZmrcHSrnUoPCRyK7puBj8Cu40mbZS0huQZU4q6AetXGgyxd5CvpDa6YxvFEH9NBeW065BlBur3YAES8Vs6q4Cou1lrQa854Fgt8E02JrR+8zBJ5StBLwk+nd8ejHfCZbhBK0NQEz6iBDo0XIwFWjECevBBHwB+k/2+XPTkkuENMrtW0GxdZio+TxtuvpLMvlN7E/btZftb4ZmHZqQHKexBaOBAsi9Oyc5Vkchb3b6q+rTkXBXJ+Cfm3lu0vg9qajQAblNaIUY73Si4dRxFmGooHEsJyOMhbgJv0EZDQE+jsbBEaYYw6XQj4eb0BZhqHBwDP3kUBL5B0fP9/DeoUb/792YpbNN1+PwUzFP19DTE5C7eL7mLTTCfjnWuEMKli3kCrm3fzRgKV3VVOyB0BIrr7c2sjK1KnPaAoq1yF/w/ijmn/ehxl3A6l/SzoDs6svd1GBs5oY+ECtN1CVe0ZDMIrJNWkhifMJYE5wmW2adGzOGhf/nrYIygOVy3Yuvq6ZNkWbhGZGidSUUFeSSso9joabqvXMHQS/dnCuG+1hweKTG2JgmpNu6PzZ7V1LsD0Y0mmXP00FuUhOmA4ggEbrv6iO27HY76tZwEh4XGb1Et0BzEU5WW3YnuDTPkRg8+s+08PILa6YDPclm+gPdGwrMb4rcU4P27XzDb1THl9iL2bxLLENOGL9DfBpvRGf5vp4Y/ok8auJT+8FxQ0x0eZOgU7idTFs5RSfJwWuow3q5MiZr4lC14oGXebFSOxu1xAClf2MMjkh1jqxQCtyjae9AfdmVodTR2K6B9jeNw8WGfvcNkWwLJE0fYEUAI6+SRhtXhP0dsaQpTXGqQTXuVUA6+uLU0kBx4N8H9Xqe/TqT3teBNtIVCfIhdYgtLWipaOHNyEImcyPCSz0wsLNGihOibzGEIr+G+d8H7QnqWKeHMafyf2YsNFTIUS70eJrCA+MBIHmrs8iUilT1GB4x+zEtH78STr4fpNBCdV3yWR1sAVq9ffpRdO2g6G0y46Kdhb0Ju8oEmDl4zzBArDYT3IVVv8JNtwqpNk/sK8NyP+akUS/TbpLVtMIGT3wdlWYubcNpgPKcTYht1Avh9mg+y1RuaT3Uwaj3AFt4FQg8jL7K1WXjtBz4eYW1zRSC5Butz+DVsm1vIjE/wf+npy+cc+yjNFd3uuk6tcruZ3QDamkJCnAvH8izRq323PCvTlcfTiS/Sbyy4FSrsFu4/HkfhAtrxxfySK4qX8J3pSjhd4Z4FezQVOp8uUuPONHNL50iN+ITTBbDVkG788sZU5XbsS+QYBtE3njpSUonayEseEGN6pWE4/bMWXBFkRi6ZFRlVDk8T7Vim1hSNxkfTVtg1m4vMTlkzu9uJ1FUWtm1Uix3DM4efhZzKU4KfeyweyEbWvFy3pitJIz/XJ54SeFtpKBvmxnTF4ZrwBfncg6+UkIBNh7RGzuoQxVB6KKOwtmFBDkUNa3YZInG1OkFEvAqx39oZjUuZig27lhUY3CyDBzCZ8DV4rp+8D5I8RgN+/HxqQLWJRVhC10rQaFY9XOyBukI9M0FrZYnF7RyeSGm7V+nVVZSOMoL33sHVmv/u8ZSnUU8c6h2fPMeh9YVG43rjmZa3+4Owk6jRegoJXxsPWeuVnx5fqRr1DAvKVYaaPeaq4oGRHeSjkx30v03GHokxxj1/thTntLXha858yAr5zrAam7K0pihLQCnh3XG1tdHDA/fFrZXC0kO6eWDhZlU8WCRUkVAEUEWKUJBQuIxDWfvGSgBqmrCDn/o42EENhf2JUsK3VJTdR3RWcE20/FMS6Xw+cXuxaClqn1PEaFRYeGVcRwA0HI2uKtK5h4Jqa0vaKUdLYtSRorm4F5HkC6yVQKig7UdrHmbsaspGZtbjeu36RIPM/pCwmvIoHWWE1ZSDm2Y1lSpPo2/251rF7WEF+T/cr9ed6UvmqiU42DwNJPuVLAtptNbPJrCj1UZmRqtOPvdIgxZkhRebnYQAoaWKsIQTOROv7bh+TZyl9ArgqyLZa6nL8esk4zwyzVDz7SC+n1pT/KEgWk+Qb6lqpFgBUOZArAxCE6UUD4f2a2PPp4e/lM2clP9782w4ixU5019/F4KUUK4ZSSDeAYQ0bQyISz3+gXgDkSOs07jobbEEn68JfVb/ydxw0gmX42aDcoS04W9vCdB8bzy0g3+atIevCV2Gz/zSw6Kq2E7fYiD0i9BGuttkqRARYta6YZryGGWU4nzJHFaWFr+zIreeEkWKKqQU6zehgccb27oTsUouW1orpYBfRVXJwi0fX+Foy1+m5no1gkKoZyqvNSqK0kH6nkB6PV6FzLOVQYvuYfFT3ANeL4fgvJfhjbONuKUKfIQU4CEPv1Prer73GLNB4s28A3NqHL2Xm+Cl1vcDQEvojbIL+TVlVA2a2gGjaT9k3dQpBrBgXahAr9rd5iOX7H52FBDyphhsSyf1T2WIiTEzNMHz5w1N426bJXF7KvAFYGNbjg9C+JRFbcCEADmDcyYVqaddBYRzoRrWNHr+6DdaAHqzL/Y65XslJWrNIjdgWrMbq2BqTWp2VwEh0EQN0/ijK8nRTV36MD6WBw+8bGozjOXTMJJzjo0IKCMv7Nyw1GmmIumI6sPJBZOCaCRcjkib3X9NJ8XuwElbXalAWN1kYqIgscBRGB9J5I2+utYXuRcZ5GMoChv7IDIcjH27bSMpeoKUGkpyY0gwJklNkLVBwI1qWfMVpLSs+/XDsYneV5MUy6ZQ1DkqDafYTylS7Bz1wKTDHGE7jfW7hOSUINIuFGCy62vmKHlFw6Kt4ykl+NxoCBilq7QyNLZLbHUldXhTN5JkKlaCRrPXysf+/bRTKpuOXd/t+qwaQZAoRNZ1lUvc2s1fzYULcZ6wBvTjFtUIEo51POZEIm2H2YESKAOVxVI2quVHI/Ug+kI1HI3hmXa1I0Cx1tFY4k80dHGzB/q4AjlxadQWHt3Q3sDIJ4+0iD0sIdLgQbl+himCl3sE49n0bAF5/m8gj8uV/3B7tDnQhxGZK5GW9jWJwz1ryi8C9tsQnCTQ1+aWluV5dXrjHGIM6ELvo9nF8VY5GsFQqRUl4yWOFKWuDX8zEx6bFdUoR6YYN+I5GOIF8TSZIqQTQHwI1VWlt8vwVpMy1HRhS8FCje0elXMa3R3+iMB7VWr9h7oc61G7GvCeM4C+U647xJnECR6xQaNJn3JFb5aQRt+E+b2Rs542r6sAaz6PajXNWk6bNFTTfLZfgXBchMnFrM3ogsm5aAGqvueIRVWAWKFJW02JtYNPkredA7z0qBNVX/fLSK1v/duI2CBZVk+yEuyWbTOxluqJY+OknaJwOngs6wcPZOOc6dhj+VLmYy1BaxKU/FLrMIkn8tUo+yQs8e5AhMpRgl5iKTXOjJ0nk3tq0BevIQYQjvIn+kWq5Aj2STW4cZhY5MmOGB89OkxA7Com97sRSnotj+Bqi0zHm9nxGUHcYN0f9k3K+vPxgWLpFQj0Z0uILxQdlWGMQMJQ6ME3ghgSiyeRqM3i0SAszaNxX989k35fFJEFQ28TTRJmNy9cZJxbbHVkQ9fCt2MDLetU0EkQ2c5F5BIX79De0cqjCcS48gCMtDIUYMN2DsdG4mHrbruQ4Ud5E7Vq1i1f1Xol2x16u7pbXLggruL+Nqhljf2O25MezYKofYb7fK2JjUYji29dhuEvy7b6k6FKGOg/RexSWOIkHzzHMWM93y1NGrazUS5fnuS+9MHJBxDinFM/QfhcZAQgHiDU0/ujHvyftm0LEHKSSLviqK8DsZbxKcQJwTuMrh2+HNoPOYQuinCM7gKtR17844QEnfe4CyKRajHaUakrT0U6ikngcjceLm6zzZg+H4hNVa5Ry+J3xeJt7A7EQm1X6iZm3eJaHC4ATfRwfdh/AM/dJgewlMFZsWfXhLR8/l49ghsuu9LsYfAmba5bDdb78MD0bBsGKo7Mw+Azd80N+6MRZKLo9B9Ie5YhMvJoksM7Kzch0kx3yYtpCi2NIAhkOYVekzlRebJP/Xd9xfkAcm5Zj3HXX93lpdHZQteUOC5R5xdtfk4DWSjWQZKl+rpR9DpdVfcbMZMX4ItpQvvyway0twB/TeCXYWehUsMRihHSgt5uQhzDyKpC3BcWY/cUYIm9Tg69GBxjrPd3muoL0zayg5yPdfAGRIw7pooQ2GNUwKGh3II2KwLgCbE9BudUH/7WhJtcb5YQuD7Off9Cntgb3gj/QrfY6atsyt+NGxMhhvsUfwQZwmE10Aa5TdgF8EW58DSmxrFkqGPRszXI6ccJ+HxRMkQaQ/VMfcxnobn0e/ao9vsUjjytV+/FQkKSvB7++jgkQTj6e/eRC7fetULUr47FXRR8KoCuG8C/cYSicxWRvF9Km7kN498YJpRAqCGFodlAyPZSQrSM9HD6N1TJ5VDqGrSH/XruFO1Bf0gXssLD+/2CuP6WvKYWD/6jJtZRi8ny5VlyAW/UGgDNZcJgzry9nGPyUGi6XS6YcHew35FbKLjAWg3GhcrAW39vXyuEQktR3B4EPMuwGFwq4Af1PMnL4RbxtNs4/JLdq0jIgxkiC1Qq/cn52C6es3AIJunJVZC8bPjqerlRTLrsixkuxkLg5ClUirge7AnUIzjQYZu3G6tLN+XWJNXq7PxHiWNbe7e6cEV8GiJDnf2eHI9mF8VP9sAsSWdBrKhco5LFlvNJtw8O96HcmgmG+nPDXL+QXBM/4vxRj+HVRhC+yZExP3NAuQ3DGzODmh8OVTRA/fZOko8jm1DCBmL93XA8dKaCgCOtgu0rsPUjAU6GuOz6TzN/rj81nbIcLAzLUg2xs7EhJvUaeXwaaIAslfBZzcw3i4GLo8dxpxyMt+CoBb7k6ot5IUtiQdArd1gZCNdPf2hemgkdcNlUHgh9wLVVjBROrgIyRBYA3TeAgXQ1Opw/1zdaHEvwGBDgWhz32byIn256HBpBqQfL806ohxAnRKfOMnfpImBMaEiu6z0Q+qy2Grk8uUlp5NGem2pkbyBezBL4+4TMlKxGy92i6tkcuSnpQLBEe/e6kIZLrgMzBFwU3QcCBC4LuUTJ9YGRJ1K09OcdR8Hk0RSjYqO0Pdw5CiOPnuEMco15L3UCq9wMtxH4sAIAzf9sorJD5Wa4FscSPGQIXYUXEOoJpef9API6xxmmH4Q8ekbfF8k75FjKzWgljZ7RCsCviuBmtAMhE/GkAzQiDkE77h3U7aFVsagjO8QnkeiB/Fbr9i2L62x0BybJtDx+v3XEMLbtPYch8S1vNscmA/EgKml/Q2tfSz8XJeXjXR5W2xA9o7IBpwi0KCnaoCWm2W2IhrBOsM8neHxEk0w9ALMGtx+lYrN5AFKEwY1iBPtjeRj0XHArdFbK4E99W7AV108fRZRKGbTS/VXoOlXQb4d1ChH0WeXh6dEYjnbgqNYOtRO/7Rd8atubbfGDismob8OP+EupPOTDT1KueNaEVhV0IN5W5QhcAOBjCXxn1rzlYlkhBI2tAP1d8iv2Oo0zVMtMHmpw5QwUm327C8EmoOgNlBDnwTr1u1VoOo7Hcn7OLpULuHgRxc3qTxk1EU24B4/lew/2aAKvLTczU1DbSkluixWrz9UZwRTlEOpI8fUCYo2FleMqhjc+8o+bPrIeW7Z7ThqhNhzwDfvdwKnARtUtB/DUhHanBYaTUQ014IrWDAx5rLdwd3UV7l2XyxzEDhxBjaB8W1tnLGVQGfrT8GsXLqJ9nDmlcls1K4+jkPR1HUG88nohe8Lk008WQ2JwH4SPWElbAuH0wTyuDxRZXQ3+iNXCznY61tsZmEYPFEAqoQWEGri1aFKZaKklIC+j+GyQYJGrsp7nkVoIo4dSks8cDYMuLObrWS/pRdGKKDZsvwOplfubgQML94nmzMQQWnCPNJuHu+yHa63L/uYhThRXTQvprqWCXi+75fQFEFqaFYBrnboA/KdGBViEj6PKIdK8AEILugDs+Rr9VPADuMEJ2xgZhvVm4zJoRehisDvYC/0uHOSIISQyhvgZMrHlqGsiHeYLuD0grzUsAnE4GvL598xYaEoudDQgF1Z1OnKhA/+BNEB4Qdu6M5r5Rsf5lRp8XAUomPiBXUFSJohbAT6F8sg4syWt3cRBxLW7OHQdPnNxcJZh5WFX12+xrApN+Zwd8tV+D7pC/6qfDtlfn4zH9ft+ujgauiYEcRle2MWoRfguX7OUm+PxuHIHRruG1e2PG7AZGOmt7NX+5ma39GtocksmOX0wqZ4+p8kUjWzVTBp2vcfen78PKtR1bX+UZjkEmhRoZqXNVSG3eD5ydtw91vWN6TiYQhcao8i+M7CT6zuH42voO4fv5PvOoSP3XXzGv47rQR/cqB9VimQq03S9WduJIlmn6tOmpISeldd72v1uf1jf5z0R7pQz/GcZ/Xs51ddccE2gxH+k0zjoqz5sgTfH5e1xFdhppLk8LaT1pQAKj9G09EILmp49HmoDWxCx1OF/UP6vKUtiKWzQJnaXLFC739PSaM6rbPuNKaeb/OqNqsb0U1mBqdnJhj48G5r3vNDytfa8pvzn6XlN/8/S85qd3PPM42Lr4P8e8T2SCsP/nVKSL2sKJJv3IEjT4ihtJN+sp8W9mzhVgRocTsB2tjeGULr6azzBIkhZZJoBtlhsgze5y/bcFom58ZUkqcNJ3pYg9Ru4+tXhjQzP9VR3Jrmmszi1Qxc071Smpjkt2cawWeSpMX6gN5qVg+oKcm656+Xu3oY5OU7OJnZRisviPG2PuecPxN8ZqmvEr6TmkVFvA9EzKED3Kq42NrDRrFEJuigs080XlROfwjjVTGlCSJ4j+xvcUYxwRwrB5Dj8a99xJrzQCAehVO7ASMOwdX/TJjP3DpNkGkV2CdpkSbdSqGbH7VaKcJyYWynCd1JupQgdeawHxolJ64wbJ416DlU1m2K6jlOJTdF0U/Ubma2RJ1ceJNaeQUiyGhApQkQjnVW3uomHYGywxGYn4GZwm3qqZzuQs4Ja1132QK1gMkkwglzD7cwVwD/TuwUoke3HMZfNY4o1AG2FD1itWTIQP/1RgoLL418zU4i5rbJ9b73/XvTUMsKkcGhGdkrKkbcm2+vI75jFJ1C07xjDrRQ9dZPyEpqMg0gHeAZmV+9VGiOxjszec/CqTotiMnLlCBkGzcTGfAuiHPT9CAyNAJA47Hl1ITthNaDRVytp8Dzt032wVGZEDNNU3yoKEfkz5dmkQEh/ZKQ16h1EVZTy6TpHpUJEEE3VNwQectdEjPkVdBcpXKOuSuzjYiTTdVlypxAmnKrrGvCRuzD4dcys3mtfx+NfvYcoTnD1HqI7udV7iK3R6t1faARuGqQ++426DVszxTBdr6lH/bBsU3UalaxR/EV4wfYjWs9NMe3Ua280nul6MeETTnBO1ZfNKBu5PrylcDK8orYUbtSH2IEqCabrPJU9H0k2Va8Rucjd5e8nUGt9ATiptb7WfuJrfc100mt9TUQOY9rduD82sb2mTctOpd+OejHZZ4BfE9JJv4oOG36yCllPl+bm7bT85g39DIODJTkkeCB0bzwPehAhtw6nAyaRQr+PyqXKJN6ikFpgNOkRi24TbYQ4NPMIJXC6Zk3GNcab9bjjGpNMJxbXmGQ9qbjGJGmj7Ult2FI61QKfcKe6TF9Xp7qsX1OnuqTkTq2ZheThdtgsHPfhdpTlxA63o4wndbgdJaTvPZeX2ITuwyUweEQpv3SziB0khZPd4bOMiZsdtYk5anCaxMpgjf2GZahroJ5oya5z+FPOomDHk7jF8sxKbVCPvXEuYKWP7ll5jCryhSyWF8D22Adu8WXJHDXoNQZrfAbzr08sNi9Bg+tTqhT+NZwpStHg+lioJ95s0O2OmkZmPRFJiuSczsgnQpyR/FOZ/OnpyR+A2Dx4u3n/T3mpaLlpIxzjFaNajpNGZZhqLBxPERqPB98iTTEeprws2Hg8HOMFwsadcXyXCo+nCPQz2xFk7TUJ6M5mh4GSxy0C+JsIEmH2+ub59iyLhyfdqFLA1gP9olAjYoYnOTdWt+AVQ7F6RoTy13gteKP6moa+iu9OD99oKqtXQhqQTTd/EzcIcsRTTdopeBvdFKuP6GY9zPBfWw9Lsq+/hyXx197DkreRC61mOpJXcVKm47iv4mS4TuwqTob3pK7iZGjJnbvXLdZLmXDue6k+5XLIFKds0EFBbhrVyQhGodoGkaJBNco8PZ08JqjTkZ6g5tOB37i36pe8Q6EJLRjtDoXbmMkojXrtjjtKI8hwYlEaQbaTitIIkjUzmP4ISTq0QiPkuO+iRDhO7C5KhO+k7qJE6OiJMOAdRss7qW/wHUBqWP7AvwwkTncnqFhTANwNwc+ZY1ciZP7Om0xNNNldlC6iCG1x0iVZJFQ8oqjRyL6V6nok63RjvZbQuEEJphr9x1EA+lkbSyZ6ZgTp6dWLS/kBwCBrHIIb+8z7w/KUthjEGmtz+VFvUdWUkPzhIf55UlVrShqN80TGBxTjdGM8kcIAxT7V+J6WnL743YZDLXn8mFz8cjncWGb74SUmLk8KEdeThHYPR3Kx1AmTIfRBwuMOoY+RnFgIfYzwpELoY3zkYWil9kxe9ssm9tTPmz7kpVJKz6QHn8isSUrk6epProVs/Y2GWOL+iad7upGVuLnq8Uw1oPA05HH0SGLNLVX15EyGjHo7VZgcP4Ersma0vK3qOiy4PTjLr+tjjf2Gy2nzaAEmqfMM8vfrU4OrswTx59kL/UmvM9zhzyarJ4uj+i1RNMMjltD9LuSu1tuQaPmNIEK73PmMwIfkPIoTiqk1GeDdI5pAthSuj3A8ozO/szCZN4tt9v4SR71TjbfuyOdNrtZrHOIJaiCFJnDHWoup9h+ZzREbJP4O6Z1F5+2HV+x3vJJ8Gmi4cu95fWE5hUUWcicQqBbGF6lmUAVlVjvlmADLdgvCvvXYJpfDVkEpx29iSuyEFLXkZ5TS+LlMcAfiStWdRWNka365TDEElsLMkjOZEazTpEVuxWSngFZAzjNrqehtVPLpg9p6DFEAhqawsxR4Bu/Mjdp6N0vfYF7sj+6XXZnb/2NlVsXfMrke/p1WIV454iq+clXIB5Bwu5l98RKSqPx3LKPk6hJSeAv0WABWyvFkKJU/n1EuZPEU6pE3d9WgNIvfcKuG3Y2uenPiOfOwmKeJyRh1mTeGxftawjmjR7b9PqSn3JPHN8LRAhRruRgW22o9Eicxonj9+2UxUi/6+cNM/JQZsH9hgj+L9r1FORZO15pZKhNC6Bc4hfhtdfP/e2m1IId+Q5YhtN7vpPQStB6sw6qwXapW+G5UrRTD6n2kALrEP8ipJpT6UGAQrazksJr329WwnR0TQghdWiGeL62WQ48JhsiPCSmF1zpZr3QjxLUKKazWIymvi/v9jGLKKOYQrTk6ipUYuudK+HFs2iLac1oOq/mxRuhSW0+MR5QTSn4kQfnWNoLoOVLCMzrZOSKE8C3NxfNzRMuhRzND5OeIlEK3QRcSgBZynR5tAyGE1glPiney7SqE0O0qxPPtquXQ7coQ+XaVUhStw3HW9kgp9GyQ8vnZYATRtodD8rZHiRFaAhZOiJbgUoSW4PKYllCChJYACKYlhBh6XgBKr1Ci80II4Z/85+L5eaHl8G/9AyI/L6QUug22+9HNlfgpuer9G9OWA/aAdqwtpSohhK7x+EFZ9kr5Uke9xlKplEKPppWy6JhXz75X30VIvUqOsIVoWY0QVyyk7AOE7N5HQGD/Lfc+P8goZ5J49R8IkHi/z5AEdnEOiZEnbGVX7T79fpRBilEa6anEOE6OF3MMNZ9GjubRYu++eOFexY9+RzhSXPWWFClEoTVZH7WHlU6Gczqk3AiR8rPc6Y087d8NabfFKPofigEhVZ8KqhYSpAMn7pbiOr/0DBT/JWmf/o8uG/gsK3g1JmaghCophDUl72+Wwhz/NqIPfkebJfA8W2apbu2ERiVFUtvvdeUTxCm1TAqt9sGwsp6OjKlVUg1tc8A8CL1KjGIeDt5xihzVrcQouus2wZ22QnNDk/BhawwrPHDADm7BJNqo1AT7YYCiJkry1XInrzCcvwkqZz+TLI6A3C26E3WK6BpLW7GQmspYPhdSfly2MlTyYzGVvw0pphvKI0gi0LPiOn/jWUvzMzbL8u56d6I+FLUZbqljYninFdz4H20UKgTv+ZRiLYvVvtsZFg8QJWZiaJ2msEmdlHK+vxG3yLZKvEXeG7ULvaZN6eRyeK0mWDKt1Y2QzGwWr8GAsV35gVWapdtI4y3yszk1dGyeC0keD0JYnl+H4YSvj5GmnH54VUlTGGk8xeFCd8dmeCHNoIQJX8kWG3o2xZkkhSVOIWEjkUBixAkbplWtwD72uphk8jGEnc0839svyPknu8f5alg8rjApFqrFlXnn5KdVsIg8tvWE8JHJHnDtgjSqaf1r1jos98K+B12FFpIr/h+kSbhkneeoUw6GJbzbXXaCY63YgP62H9D/tm8jz1oiaB/+egnZA52H+WuHtWdtGaziT9s8vIXHFl6vRqC5vaVWNy/UGILCWKqnsPWZFU9awX+ptV+Nw5VCfz8AJjFyrxlSLCXQSreKUUapkUCvdvq96+UIQprE1762Tzyrf0c7xfq9JTh8FGX8u4A+/iu60hDokam0kUAvmODY557wKNa0sZ+wen6tpycUABpp0oalsePdqRvcswkMYfWgBrzDVvfonfXkCAzBSRhgiM6//ApItYQdgfxt+6thGosebvxUY624Y8fnY7STg4yfOIa5vkkyqtnvpLhi2Bg739G/c/Rav2K0Pl0pN1h6VxB/GwT/OPPnv7z4cBkiJSDY9peXD29B1CZ0XLv85ZXd+d5k+1eXLh7cLYYVcy/86uXLB4rq/QsXr+zNMf3vX3zp5cNFNQjef+nCxUfWON69cP7i5QPWmuVwvLN78fzlK/tL5Xir39m7dPGVl68c8nVMCej9iy9fvHD58sFsG4bSqD98ePH8q69ceOniIWuv2W5VjB5evvDq5UvnLx9CFUqoTbt8eOXSlSsvn79ycB3eeoMo57GqyTdMRb7J6/EtXYtTug5XRQX+8Rem+DBC7dL/7hszuuy/++aMLPnvvjVjiv27X8zoIv9+5pszM6a8vBNMYX8/cxW6QpX09zO/mJl5MoIzUT0VIeL3YGPS7bKi//1et9quxn/6VIa1aZE/ORQRQ/Bf//B0tNV/sMS3zCz/z98/Zjd01ovhzap3j4n++nq53T915tQ8LCN646ronhJriFPzraU/vLY1Hg9Gr507twnBuZP1sxAuzuLVt/q9d0dnWETdmQ6gz0HFBPaMGG9nytH2U7bhh1ZeHpaDstf5w6lOvz06wzLoWehutX6uGFRn2G//Hw=='; \ No newline at end of file +globalThis.dmtComponentDataBCMP = 'xX1Zc1zHlSba44lw9FNPTExMxERMNy15lcSdkii5ZREEARISQcIokJrwC+Ki6gK4YqFu+VYVKPjJP6Fn7Vk6ZsIWAALgpn1ztx3R/dr207w4osO/pU/uy82bec4tQv1gS0Kd73y5npt58uTJP8786VHRLQc3i8G90R9nvvFglFc7RTf/r3+c+VcPetvj5Wy89SUTGJ2Vv5ztFaNuWfXODAeb++Ni3M8fXRN/OTW3lY3fn1T9v90aj4ej18+eHe8Ot8rBu6MzRalgZy3FX7iKN4vx1mTd6H14vRjfmKyfWsmHJVP7h5eUXinZLbc1xemNnfH4dL9YP1tNBuNiO7d4PnV5BsNti+TW8tKp5ax7L9vMOcklRXL//v0zIAqlZzxDIXL2ikOoyPYmoPyvjoYgsTjo5e9BSx5tFXmVVd2t3Sf6385sjbf7D7bL3qSfjx7Jf/I/PhX/sTiSRfmHp4Nsp9jMxkU5UBoPt7PqXq+8P/irg1E5qXgnfWNvnL83PnxeluOwu1X0e1U++O/qp71eNs70n/+b+vN+t+yXlf77f/7jzL/mfz/gf+/tDaHZ/vB9WcKza1L9GlO2xkXE//d44ffuFYPeN/a7/Ww0+v8zM1rrP838O613ztJ7hkvG9Qp5o/4ff1HXD/8eLPeFjcmgy1ouyiD+cfq84bgSp4D/5QNJcQ5FIRBYgqPNfLxQVtvZWHBcRHFoELoeVTbolduUeggEluDwZrbOu09WoxiM82oj68Y7XIEMy+/+ZCbB091qwSNBBJ7/tPtzOo8CEXhmB7sWzxmwNHEKJW8ofj9zaiZOcnRj1M8sFmZA4ywaQKE5BBSpLkqeWJcdal0kgFiXHWJdhDytLvfXiXVRAFpd7ttzE1EXKU+qC8xlWl00gEbT3SLSKACF5mC5P9ksBoLjpSSHkCbVY2WT2FwaQOp6QJG6XsmT6gJmj1YXDSDVBZZkwyofjQTL800LFSGUWKT8VGl9PDvaHXTnHNXnm9YqUrUDQS9XnnLYtdytxkUMlwGh2R5J4EY/G+fyu4+j4gg0z0OOuj4Z/LwYyu7H0AgAsTaLA2ptJALN8yFH3WFlc8hexpDZMGL7ARS2MYT2EwDi2PtpMXQGBGrsGRCa7UgAdY1Oo3go9Tl0J+xLCQLyXD1mM66X31lduJzYvkjFRp7GYdcCw0GsxwOnv19MEtD6+Xh+QGslI4/f5Nmm5YWEfqJVeeDM8VTrUGf2PrcHQvcPE7q5KN4a1g1Uyhq2sk0fcNQyCKxuVeVkc0twXcJwWSh8X9tmMNXXRAv4Ptgx6eFIKAZB/AzwTWpqBrSwpk8AU+uDC2meNj2wZ4z2D1IMJHvtWrqIB0JqV/+Cd9U8UpAOfEySPiGPhmGwRMc9z26naQwCX58nBmRqdIlARanTg549iM8iWLg4vjYPJcJU5TyWhFKPg03ra3EmySCk8bU4FgBTifRANgh0XxS2YU/3hRQn9IVEUPrCgqBdm6NxtVCV23fk4iBdEw1ANxUgVktFcBpDwMSx6vetwZRWThxLR95QSjcPeSQdAELb8/RsENKE2SAAlNlgEFiS93UPvJjUTmr/B07rp7uX2PZ7puVfSusmtfuh2+rpjqW2+ce2J+D2kOsWXK9H/OABL4LE4t3hH1nOAYf4NSSxA8XzfiDAPuurWNY2nKKV5Zq8VSu7WDyz8Aas5tV2McjW+/JL8wqS1eDwjJZfxanpZSSnjaSOJrFRaDWaHCi1fWEJ7pBi29fg8IzCiwnIoenPS3g+jqLOFrYBaDVbLCCe80nIHL2cZmxriY4XGGy+qpRX+3yay0AIPRcwdoiea2nnPha4zrjKs22qzQlg8cwPa8b1AoKxTR2fhEwqYqS0taafSGCgUX+EZm3ZqsITJJyPiKNq20EjQXiuz23YHBRzXE26YzU9fkyjtfD4EhxxDQuFsnDnkJwMQZiRGgN9U6JnpIOi9qAzarA9SB4thxw2zGU8y1kkDwBored/GHCt1+ar8LHAtbNnASyhnvDZnB2Pq2J9Ms7x9XRQhFECuMXBcDI2gx8xSmwQ4cvnL1wQX742a5ZDd7mCGI30lcrD2iIF8dVptT4RZ17sgyU3lIjj6eczhtlkGHEEfiVxBL7HZYV7FqOfotoU/QWs6tPnkcoPmbTZsb6EJWDNg6T4jLc/X4Fdq7JicAPC1/rqm3g5HJFgL0prSEpowudGhTAnDvtrSHYHSqEXuys1OywTkSa2QRTKx7zEc1m/vw7Bq9G4D3txrAAUqo+a2vVSmq91k8qF8lK+vZ5XDuvLUdYAjEQLBS4Gm4HKxmkDMFJv8u88pTcdAIXqqV4nwf/AEstPTJrMQCh04giTYZ3WvIDja9GU7EvtTcOGqCvvo0adgU/MbnMOVtRySuxkVcG0IfaoDGUITzWQidDxgw0ebmyHmksX83o2yl+5FP0mCeyakMQGj+9l41IFxDQ5OF3FDIA+LGTCy2V/d6Po96X3As+igGhf8Pq4zEh1YQB0XZhwq7rYQEpdJtS6TGra4RAVxmMXxmIveHLBjjHVoG48nXJ5BAQf2c9jUUgMAoI+4BHid1YWE2e3IRJAoQ+KxY2DqxMwjoX2cCLJHCh6xAmY+OiQRpwNxLJ9IEB3YOF+ebaqsl3pW6EwGjC6VTfYSaTHiWxVF4o/9x3dzfpF6j6LSyUx6J4bl36dkD1nA9G2YkK14QxAtRV6nt2ULYf9Cj0vgHABDLnHOGYde9X64F1EUzGk/FQit0zj0mY6j2aCFqTwHDgsTcsHl0dA0msHOa538moEPS97B0chMWiOu/MrncXbtxKrIJdDYuyDV8mSGHH7747KwcvR+3KSiQtGlzz/RSt9q3P7llTa7Nh09HIE4dhG2N1iY9c9lwotTx0eH0dZpvK2kvv+dFtZR9TB5eFf6KmYDYf93fleMVa+t4SBEdoNCmvDHndhTwUbyW42GKjdQ8pkCi4HiKX7aANEboFVmh3fLGEA6nnzlyjOOhr9lTXQ2xsbo1zeR3ydSCuw6EWY0JKIHnGpSPceH8JNSbcdX0axWDAKFWsDdvmYSKVg6K+4xMCnf6IO7ylcHIfuI5i0MPUpfSQQ6CirYVaNUtFujn4OQC/DufRqlSunGJ6CgdAxM0OwkXDzHGDenvwNHGEdjjZRcJIGzphyezsfKHOIM1EOEN1fO8WokHMW118cgF40MvOcOhJw1DMAIRRF3JyG/c6m8xn8SxxZDU04jGDfa+dD0hwS4nBaOCLbXdby6oiWwCZxlHvZjpVtPpxyqOo2Nnngt8RsSyFgTv81H0A7lAE8nn2PWU/S2GQAwtGbMQCpsAWHxcAIR4ochAzgqbOR225/JRtsJg/uHSKOIAR+hKzvpXww2UY2nmt0vxX/rLAJafXU2SSPBmApjuHEbJy99zYIymZLc2gEmoRZz5V8NOmrZVhiOyDsrUCQru8yu2IWR0GneM0OuasiBAmbb6ugGUui5CkkDzr5JvtiyoPeJIcUJ1FsjzZZ9hlB8cPovkmKJnZO/77hKk7cWyJ1425VQ6IZuZeQtwVmwfE2MNWYTywWamS+GvRazAdeVQ6OG9MWATShPYhMHoDO/bA5agFcJVjuD12Yrv/CdPSE2sPNUysoreFGvTeCayFpqfub4j4piUNC8Lc4WXImZeNRDByA1v+Qi4uT2+hd8xCLgOHbS4xhUntJCJoDjpI5wK7RqxQmYp0eZb3ePPPxGxfjZdwgP2Mj0bv8bj/Pqg5PxYXbaSk2C4jeetunYKkDAcUzxTEYloJ2Dga61Rcg5T5QBBRj/whuuA56C/0yG1+8QBsANpJwp8rUB9tgAoP+cAjxJVhgFUMVRJByxLlUCou21sh4TY+MfjNi4ebt2dWLF9ZuL6+C670jp1BkXauoPCB2eSvNkRsLHlmxucaohb/7V3Pn5dozcQihmObqxw8Nqn9djG7BvnUnn+12cwhL4XvYeX4TR24QriM5I4qwhfl4Zb4zv3J3fq2zOruyutZZnp2bF4V4E1mIgAIs+YcMu7p29c7CwvzK2tLta5L6DQK1AycQ3+nMT0PswdEHXJMBJLRUhjq+IZCiuGOnDzarbLiVb+eLMOUhuEUuDlLHDYrDR6N9lgrYGfaVuy91uu5zcmiaUEYwiesG+iedR3O/m3W3TBJNnRXz6GeTonvvdL+S0S4NJ7BC7RpXsqYhuLY//AmTv7lyR5r48DKpgUFh8as/19cTMoINVCQzKFOQbmWjrXqj7mcm8KAhCliWgeHXuHS0Lf+HyaUHACus4ZVoY1raNQ6/xNWQO+NCRlzF+y5Ex7D4/E1wcsNPbdj9+LdzWccfN02YOq2HR58K6uK695oigydU1xbf0fd1LYNOnDqZUytE0jqQXyjyfk+tedAsAkWZDAcjWPp3A9NhD85fpElvuC8gSyAUrDHx6HT4Gz3RfjbJK9mADVEqddUw5QGEs11PVwHQ4difGKq56DSoU3lK0PPhMw/ojM4bka5MFqHFUD02KuT+A9sKFjkl+RMUcCXvTbrK8xE3PjafjcUnxTOldGivNm4TojWt0Sc3DUHj9wZpwjwPOnaYDhaIdQ904KKjjBWKf/5rdHgK3xC9SibaEGhkXBnrCHOMFTN7fve5Z1mIaymmz535+QaB04FTyD+tDbhrQCMKMEsugKWCUoivahrg3CQfm5IstC2J1tOyOJ3J+qgL1xDdaxH04vh6SGtEWNSbj6I+PTja7J+GX6riPVGo79QmBMOtaanEwce/1R/bpWwsHUT1dHyeSiaKdxEzabkDr2etC2jGp7hnZb6IL/NFkmJ5JoBRbLn9U4p/MlEBXUnFTBTfykxa9l+ylbksvsx38y52ZDBRkmJs9zFRkmJs9zFRtGJIewHuUGsf5R9vesqNOGnxzWfBzeKe/Ar5GbZDc4ZJk46CGcpQvJimaMNwkcLAhakMlygMXJjUE3ymoHtCS5NqwVDoWihhEgOblWgGJUxlwPe1EqYy4PtaCVMYIO8frNeHpTmN/l7402rJRT+u4EOT5gi+/JE8eTWlTBx9mL9ogAtSt1xHhvYfNa4AnJDzJIC+lcHbP8JJGuqjBDdDkyJBhlu7o6Irl87PhTtMykQ7SzsdPlh9q3M375fdYry7WumzrHoycEe1D8J/qibKSfbbcOHZ77i4kmOwcFsQFKZfsmlYB3CNRha/xIAft1WW4KZxzJVzQXS+vl6+uVquZGqJGNWsZNHKq6y3Wl7L5T28uHIli3aaD/nDFvUx9GA7G8CLVXLbUF+hCxwwc6lo7/4/XZN8B6Kk1idyqNcdYq7SNSUe1f6/tPZ5R3vdPdykXeHw7mGFWK7K99RlRTIdB+NzRCtYJ+9OKmWeyKQCTWfl/1SJdzyjmOIUWJJfwS3u7fV3w34FXG0BTlowcbTZwfuHyVFS6oZdDNqlTNok31kT5QIUheoRB7nJGSl0LVw0T23g7YncNfpnCxhWAJMGkHivZ3GwU97LuR6cUZDv/Fg49FT52IZ2JsNhWUnSurM4QiqReFskwEu2ta6njg8SSgzeL52PutkwX80qcLU2X7XxuGwQ+uxYXnqGHHIbhfzuha7/eVQOCsv1hWgM2e61rHdXQkvQYHPWNRCurDgqFreH8tAxmMY0xs6ghMSGzFzB1BIqnEAT//TYIw0BKRP0Y1eB9XXxL6tGiclfFrfGK/l2udOmxhJIMr8CaQ9pPwFPsGP90Yw4rRJA8wXzPTxBHuqX66nVBYbKT7sTpGr1pfzEMVrRSIeYtWsR6XAw2skhK5H+6X/qHzJukOyjU/HD+7An0X/VmXT2N8pu89pXkKwJlWugAIJiQBy34zsqRgtMWo3lUKBNE4GGYi3mfsFSDuLrwcVxboZjdthVVvcz9ehrKCiyicFg0bG+UO3VYrALSBX3QOCzwFjCp3cMxkwaf0HUROiBSevMcp09lKxWCOcQ3aYQuGiBJ3CZoPg5rLVtmllUa2oiVwU6mDbITKmgq8DOFvHNyJx7OBnC6RkkvINQKkG6NFV1LXXo9xmGVTnMq3Gh8pPW7/rU+Q0G2bM8pUKnW5X9/riUG5XQLZcolasEvRAcl5ub/fxaPs6KvqzjVSq1owNt5EbjXRWZjTFyXBxnrB+KtmAAktURFBaYkKVHRbHVE7i5PElXnR4Wj3u7g2y76M5a/tpQWH5Av4PEVuKTazYqGqwWoAyBSU7abFCAl00OiLo7TFEKKVwL7m2O1L6/Hu7rKlxjori4MOnRS9l5S69cL+EG7/56OdAuNoL2NY6Lcji55AHJ3nQsVd6I+p2pUAtZMPwOuldlm5tsB8PQ6fWTzedA0Vf3YCfM5OezESQZYMcGzWkkQqQ1OPpmiz1XUUPjjD9HAx9E7bz/EpLrmtaQk6wD+2D1eQxtZiOkjeooG9yADvkFazAayIKQ8tsy3CLkdhgXmVMGP0wpUoa6ClKSVAZfvZ/nruF8k8ZvKyAZT2cm1+PsQrS1WRwYeXrbcMhKZ9bTvlszpl8haamDAbRcQgIN/0uEGVQ2s6eEtMvnPWL54ny3fIrbd8khkgiHLCWqNx0gdoH9oHTmSiuTLFVgLeRnrmF1D4N/jGjgMJ48uISKlXwjhx/VPdSmZU6YX4Mp5NaS5FzgwlPwa+R8+eJ3nJ4wYf+z9zqBKPTNQ1PeLEZqqpApGRZL+VjqsL2aIe+1t2Z0UGgPBtsOyGQ3qRW+kUwEVP4bvVLpcOisz1EPRw9w1LD418UhFOFakfVL6Setn2cE6DQG//ixVbbOWC/ug2miAoQ+mvIiVD4WrWO+WUFPf4DVgRIy5wjQSs42RTvqxjGS08US6qn7hF5PB0pY8Pm9kvayRbqU7BNfgvvmkFIU9HS2cpWr2z/RCBB7OBInXxIDMpryM9SrLo7C+YRj7yxGL103UWoYhfGLmjVBLWRj5qjNmsuftf6rBo281JH0kTvnrPmDZbShpPWHnnlXJ+NxaR0jNS0wQ7PWYGlXOhQekrhlfTd7H4HdRpO2SVpD9HwpRt2C9SsNhrg7yFVSG91N28QQf00F5aTriGUFKgewAGnwWjqrgEZns9aCXnPAkVrgm2xMaP3WYZTKV4JeEnw6vz0c74bLcINWhqAmfDQJdGi4GAu0YgT04AM+AHyd/b6cDeSS4U0yu1bQbl1mKj5PG26+ksSuU/sSDuxlu3/RlDbq6OEJ+xAUOJTc16fi5opI1J1+qao9HTVXRDL7kVn3Fq3Xg5padf0SpQ3Ck326/r85fQGmGgTPgJ88EprN3g3aOAjoaTUK3qY0QsjWTjcG3pqWfqoRMDU7uf8DX5zGk/z0F6dVj18jVtp836br6gbXMYJ3qj5uT0vu3IOcu9IE7/NN3SqEcClhHoMD23cnhkJSXdUOCB1l4np1EytgqxLPi39XpZJtlbrE/1GTE9qPEHcJp3M9Pw26nRv2uA5jK2fzsVBhui7icpZsBoF1xkoS4/vFkuA8vjLD1Ig5NvQvfx2MAzRH6Fb8XD1FkiwL14gMnzPppiDThHXg2nhm7itXMPQS/alCuC8yh0dKE1ubpFMbO2OzNzX17kEEo0nY3Hi0LUrCdEBxBAK3LX3I9tcOR/3qTYTDQuO3ohZoDqKmcsvuNO4BE+RGDz577Tw8dNrrgW9yWb5y92bEgxvitxTg/bhfMNvVM+X2ovJvEsvQpA1foL8NNqMz/BvWiug+aeE6+sNzQU13eCihU7ifTFk4RyXJk2mpw3i1EiVq4zu24IGWadjsJsrRuj0OIa0Le1xEsmNslULgFkX798uqL8OnGyO0AtrXOA4XBfbZO0y2I5A8OYQd54OwTh5pWB3+c8QWpjDFpQbZtFcI5eBLW0sDyVF3E9zsdfprRHpfC95EWyjEh9gltrCkpaKFMycEDRESCV7y2YiFJVqUEH2bOQxBNNzHLnhfjM8yJZw4df8ze7GhAoOa0quHCSwgPvyRBxS7fJF4ZI/RAaMf7NIxOs0J1sN0GojOHT7LoyoAq9cvP0quHTSdDSZc5tOw65B/fKiJg1cJE8RKA+ENSNUb/ASbsGrT5L4CPPcjfvrEkvm2aW0bTODkdz5ZZuI2nDYYz+kE0jY6Afw+TYfS6g3NpzrktB5GC2//oIeRF7/aLoj2Ax+PsLapIpCcgvU5/Dq2zS1kwhv4v/X05XOOfZTmsn5/XadPiYUvx+xGTR0hmoVjeR7o1dItzfI0pfE04gv0GwtuBQO7Rfvp9EUL6MYX8kuuqLl87Jnr1uWbrmhPg31JmdF2gVp3o5lROvtpgx84Rm8rId3k5Q2pSo3fQkd6xVNGShVRG3HRo990f7QMkn/agYt/zKg5pfDzdSJK4emhHb/UmqHFuGjbAntmI5HYFWted+sQu5zCtohqYWN45vAzj1N5SvAzjsX42MiaR+vWdCVp5dP6xFMCbyVVsmFuTFccrglfkM89+EoOCdV0mCpuDoSKofRQRmFtc4IcihrW7nrDmy32QMTLDQed3dE4l4nVsKtWgcHNMXjOkglfhcf3yTseyWM04EfPpwZUm1aET2utBK3m1IPFAajL1KMRtFaWWNwe4bGUtnuVXl1F6Sgj+OkdXK357z6b8rTqiSO9t5MnNrS+0GhcbzzV8nZ/3CbX39B6CgnfGg9Z6xXCAj1VqlY9w8JslZlmT7OqCF9kB/noaAf9H5N/R2KMaU+fIjVz2trwNWfeYoV8pyrGpiydKcoSUEp4RVxtZvTwwH1va6Ww9JDuEli4WRXttTh1EUAVKRZBQuF6jYw2naoEoKYNO3iknwU7qKGwP1ZK+FaKsvtpnBVcEy2blEQ6n8+GADRsKWqfU8RoVFh4M1yf9bccja4q0gmHgmprGw9KxZbEqCPFbXF/IcnrVyuBUEHbi9Z8ydjVlI1MrMb12vWxBpnd4WJL37WjirCWcnC1rzakfpq+NK2+159rFberAnJ5tP9yBcvlKiU40zwNpK9XpCSkUVo/fcCOUhuZGKU6hdxDDVqQ1b3e8qzDUkRYuIm8h1d3Xf9lNIIiTO8rItloqcnx5OC+mKEmqPlyEF9MrccUoCFuGNUH5HumGim++JSRHy6B0EMpw4PKfinshfigl7KJE/D/aJ78ZjEgp8v1dyH4COWGkQTiDT8JxKUN/0C8X8gR1ilb422vCJ+vCX0G/8lcNemFy3GzRTlC2vC3rwRofjCu7KCeNu3ha0KX4TO/9LCEyrbj91II/SK0kW4oWSpE5JeZ+NEzi1R5jDJKcb5k7ilLi99Zt8lFalRIKdZvQgOPN7Z1z2GVXLa4VkoBv2pUJQu3/OwKR1vsMjXXihEUQj0xebVVUZQO0tcEkuPxKiSenAxadA+Ln+Ie8FpegaNehi3OtuKWKvCRT4CHHPpOreu52puYDRJv5h2YU+PGe7URXmp9PwC0hN7I+5AdU0bLoKkdMJr2Q9ZNvWwIy9SFAvSqvWw6IsnuZ0cBIe+JwXZ0Qv5YhpcmZoYm+Pm8oWmca7Mkbk8FvgBsbMvxQQiLsqgNmBD4ZnDOpCL1tKuAcApUw5pGTx/zNhaA3uyLg17+Xk6JRrPIDZjW7MYqmFqTmt1VQAglUcO0+cGU6OimLn0YH8tiBz41tQXG8mkYyRXHRgSUkRd2rsp1mqiGdEL14eSCSYEyEi5HpM3uv4QTY3fgpG2uVCCsbjSxUJBY4CiMDyXyRqmu6zXcdwzyMRSFjX0QGQ7Gvt22DSl2gpQaSnJgSDAmyUyQtUVwjWpZ8xWktKz79cOxid5XkxTLplDUOSoNp9hPKVLsHPXApKMbYTuN9buI5JQg0i4UYLLra+YoevXCoq3jKSX43GgIGKUrtDK0tktsdSV1eFO3IUlUUwlazV4rm/r3406pZDJ1fWfrs2IE4cUQQ9dXbnBrN38lFRrEecIa0A9TFCNIGNbzmCNpsB1mB0qgDFQWS9mqlh+N1GPmC0U1GsMT62pHgGKto7HEn2jo4uYA9HEFcuLSqC08uqG9gZFO/mgRe1hCXMH9fP00UwSv7gjGM/HZYsnjMt0/2B5tDvUhROKqo6V9TeJwT5LyC35lF0KRBPrq3NKyPJ2Ob5xDjAFd6H00uxDeyUcjGCq1oiS8xA1FqWvD37iEh2JFNfKRKcaN5twKzQXxNJkixBM7fAjVVaW3y/BWmzLUdGFLwcKK7R6VcxrdHf6IwHtVav2HuvTqUbsa8J4zgL6TrzvEiYQIHrFBo0mfcEXXc0iCb4L6kmGzNq+rAGs+j2s1TVpOmzRU03S2XoFwXITRxazN6ILJuWQBqr7niEVVgFihSVtNibVDTaK3mAO89BgTVV/3y0itb/3biNggWVZPshLslm0zsZbqsWPjpJ2icDp4LOsH92XjnO7ZY/li4mPtgaJfah0c8Vi++WSfhEXeqWqgcpSgl1hKjTNj58nknhr0hWqI+IOj/Il+Tyo6gn1SDW4dFNbw4EYTHz0WTEDsKkb3uw2U9FoewzUWmU43seMzgrjBelCVJuX8ueaBYukVCPRnS4gvZD2VOYxAwlDowTeCGBKLJ5KAzeLRICzNw3Gpb5lJvy+KyIKht4kmibKb761hnFtsdWRL18K3mwZa0qmg0xqynYvIBS7ekL2jlTcmBuPKAzDSylCADdtZHBuJh6277UKGH9SN1Kpdt3xV65Vkd+jt6l52/ry4bPvboJY19jtuT3o8C6L2Ge4LtSY2Go0svnUZhr8K2yknlUoE6D8j7FJY4iQfPMcxYz3fz016tTONXL48yX3pg6MPGDRzTv2A4HMNIwDxfKCe3h8N4P+0bVuAkJNIOhVHfR2ItYxPIE4IXlF07fCl0H7IIXRRhGN0F2g90uIfJ0TovMdZEOlRs9GuSkl5qqGjmAQuJ+PR4jbbjOnzgaapyjVqWfyuWLxr3YNYqO1C3busW1yLwwWgiR6sV+V9eKo2OoClDM6KPb0qpOXT9eoJ23DZlWYPgzdpc/1iuF7C49CzXRioODIPg8/INVeVo9E7IFjel/YsQWTk0SRHd1ZuQqSZ7pKX4hRaGkEQyF4KvSZznfIknvrv+jrzIeTSsh7Srr+Zy0ujs4CuKXFcAs4vuvycBjJNrIMkS+F1Ixv0+qruN5pMXoCvSRPalw9mpbsF+KsCvww7C5XyjVCMkBb0dhPiGEZWFZp9YU3sngIssdfJofd+mxjr/R2n+sK0jewg52MdvJvTxN2kihDYY1TAoaHcgrYrAuAJsT0G51Qf/taGm1xvlui3Ps59/0Ka2BveCP9CP9stVZbk7zYbEyGG+xR/BJm/YTXQBblN2AXwRbnwNMbGsWSoY9GzNcjpxwn4fI1k5Mf+6z4LzUV74/9TOPK0XqwXCwlJ8kb46+OQBOHo791HLtx6lwpRvzoWdy3wiQC6bgD/vhOKzlVE8n4pbeY2jH/biVACoYYUhmYDIbNLDtEy0sPp30cll0Opa9Ee9tu3U7QH/RlcyPYOr+8L4vpL8JpaPNePmljH/D1/vjyLLuCNWgOguUwYzJm3l1JMHgpNt8cFI+4O9jtyCwVXVovhOFOZdeuv5WuFUGgpituDgGcZFoNLGfygHhx5JdwinnYbh1+yexUJeTBDZIFKxT85H9vFcxYOwZQ8qQqSlw1fXcs3skmffTHDxVgInDyFStGsB3sC9RAOdNjm7cbq0k25NYm1Ojv/UeLY1t4rzl8Wn4aGoc5+j45Hs4viJ3tglqSzoKmoXKOSxZbzcb8Eh3slt2aCof5cMNfvSOL8UY/g1UUQvsmRTX7mgHIbhjdmBjVfVSoaoH57J8rHkW0oYQOx/m44HjpRQcCRVsH2Fdj6kQAnQ1x2/aeZP9efml6eDxeqPFdD7EzTEJN6jTw+vTNAlnL4rCbmm8XAxdHjuJcPx1tw1AJfcvXFPJ8ksSDolTusDITrp6zMCzKhAy6bygOhD7i2spHCyVVAgsgCoPsGMJCcRofzp/pGi2MJHgECXIvjks2L5tNNj0MjKPVg+dsJ9RDihOjUWeYuXQSMCQ1Jdb0HQp/VFiOXJzUpjTzac1OM7A3ES0kCf5+QmJLFaLmfFQObIzUlHQiWaP9eH5JuyXVggoCLovtAgMBlIZcoqT4w8kSKjv684yiYPJpilG3ktoc7RWHk0TOcQa4y76VOV5Wa4TYCH1YAoPmfTVQuqNQM1+JYggcMoavwIkI9ofS8H0BeZzTD9IOQR8/oHZG8Q46l1IxW0ugZrQD8qghuRjsQMhFPOkAj4hC0495B3a6sijU6skN8EokeyG91bt+yuM407sAkmZbH77eOGca2vWcxJL7lTWbUZCAeRCXtb2jta+nnoqTcu8tVsQ3RMyrzb4xAi5KiDTpimt2GaAjrBPtchMdHtMnTAzBrcPtRKjabByBFGNzIRrA/lodBzwW3QmekDP7UtwNbcf2kUYNSKYNWerAKXacK+u2wTiGCPqs8en40hqMdOKq1Q+3EbwcZn9r2Zlv8oGIy6tvwY/7+KQ/58BOSK541oVUFHYgXUzkCFwD4SALfmTVvtFhWCEFjK0B/l/yKvUHjDNUykXUaXDlDxWbf7kKwCSh6AyXEebBO/W4Vmo7jsZyfs0vlAi5eOnHfEKCMmgZNuCeM5YsO9mgCry03M1NQ20pJbosVq8/VGcEU5RDqSPH1AmKNhZVnVQxvfKQfLX1oPaFs95w0Ql044KvKfuBUYKPo50N4UkK70wLDyaiGGnBFawaGPNZbuLu6Cveu82UOYgeOoEZQvq2tM5YyqAz9afi1CxfRPs6cUrmt2pXHUUj6uo4gXnk9kz1hsudHiyExuA/CR6ykHYFw+mAe1weKrK4Gf8RqYWd7PeudDEyjBwogldACQg3cWjSpvLPUEpCXUXw2SLDIUmmaQWVYpBbC6KGU5DNHw7APi3lTFHUGTS+KVkSxYQc9SKRcbgYOLNynlxMTQ2jBPb5sHuSyH6S1LvubBzZRXDUtpLuWCnot7+fTF0BoaVcArnXqAvCfWhVgET6OKodI+wIILegCsKdq9BPA9+EGJ2xjZBjW9dZl0IrQxWB3sBfKPhzkiCEkMob4GTKx5ahrIh3mC7g9IK+2LAJxOBry+ffMWGhLLnS0IBdWdTpyoQP/gTRAeBnbujOa+EY38ys1+LgKUDDxA7uCpEwQtwJ8AuWRcWZLWruJg2jW7uLQdfjMxcFZhpV1XV2/xbIqNOVzdsRX+wPoCv2rfijkYH0yHtfv++niaOiaEMRleGEXoxbhu3zVUm6Ox5uVOzDaNax+OW7BZmCkN7BXy83Nfu7X0OSWjHL6YFI9fU6TKRrZqonk63qPfTC/Ayq8y+nYnhNYUpiZlTRXpSTDspEz4+6zbm9JxqEUstDoRPaagZ1cr1kz4GvoNYvt5HvNIiP3WvMsfwPXdz64VQ+qHGM0ezJdP77ZinOq3mxHSehTeZmnW/bLqr6reyycJ6f5zzLW91Ksl7ngmoPCXexhy7k5Lm+PqMC+Is7laSGtJgVQ+IempRda0PTsWVAb2IH4pB7/g/J2TVkSS2GLNrG7ZIHa/Z6WVrNdvbzUchRMN+3VG1gtyaea/1Nyk417eB6073Oh5Wvtczn1/mX6XJL/i/S55Cb3OfOp2Br4vzd4F0lF4f9OKcmXNQWSzXvyo21xlDaS99XT4t4+nKpALY4fYMM6GEOwXP29nWARpCwykQBbGHbBX9xnu2qLxNzpipLU4SR/SpD6TVz96vBWJke9tUGt5nS2pnakgWSdysi0JSVbFzZ/PCXGxxNZ3sZKQXXzODfY9eJ2f8OcCkfnEbsExWVxXrRH3KsH4u9U6orwq7EZZNTbQPTcCdC9hquNDWw1X2ouumSlppsp6r4xnm+qOUKnI8+Ogw3u/kU4GYVgdAT+te8OE75lhNtPKndgpAHY2dm0ycxtwiiZRpEdfTZZ1GUUqtmzdhkFW+/EXEZBtpNyGQXJyKM8MEJMmmbcCGnVZ6iKmUE4XZeppHBIsql6jMjVyjMrjwRrDxpEOQ2IFOuhkc7qWt2pQzC2WEqzs2wzqE091QMcyNlAresee2BWMJl0FkGuynrrP3iZ78/0rgBKZPtozLXxJsUagLa8h6zWLK2Hn8goQsHl8e+SKcTcVt69t16+13j+2MCkcGhGdt7Jkbcm2+vIb5fFJ1C0bxfDrWQDdSfyIpqMg0hHcQZmV+81GiOxjszSc/CqTnBicmulCBkGzcTGfAfiFfRNBwyNAJA47Hl1PjlhNaDV90pls0vP2uk+VVFT7vBM9ZXC05A/UJ41CoTlN4yxVv2CqIgwddN1ywUszVS9gmYhd0qDAb+M7hyFa9VJkd1a+CsxXWdF9wMhuqk6jcxG7rzgtzCxSq99C5/9Kr3+uT3BVXqd7ORW6XWuVqt0f0ERuBsQ+7y36jBsvcSSZbr+iq7Ga1xTdReNqlXcRHhJ9iNan00x1VS2fMrSb7r+Uw9UUhin6sU2hK0cGt4yNxoWUVvmtuo97ADl6+jpui269fappuovEhO5o/xdAmoFLwAntYKXe5ATX8FLnpNewUsacsjR3sbO2ETdmtbMe4V+1emlaG8Bfk1IR/0kOqD38SrkI12am7cT5pvX7RMMDpbkYOAhyoPxPOhBBMM6nA6YRAq9PsqXCpMSi0JqgdGkxywOTbQR4sjLI5TA6Zo1Gn3Y3KzPOvow0oEnFn0Y4Typ6MMIZautR23AUrrTAp9wd9pT4+vqTpvza+pOm5LcnTVTED2ODpuCZ30c3WBwTuw4uoHvpI6jG+joO8rlJTaFS7iMBY8ZpXd7Fq2DpHCyu3SW+XCzlLYxQC3OglgZrDHfsgx1DdTzKNlxDj95VJO4xWLMSjFQj5NxLkLFD9tZeYwq8sUodj/f9rcHbtMlyRw16BUFa3wG8680LLYvQYtrTKoU/qWYKUrR4hpXqCeut+h2R00rg/5WYuinen868x4J7kSxT2XspyUnm/6mGfB2+56f8orPrbZN8Mwu/NRS1rQowVSj4FkUoPVI8K3QFCNhyut6rUfCM7vC17ojntW1vmdRAPop6why5Zq0b+bh/qZSKHncJ5+/RCARZh9vHk1Psnh40s0mBezc1+/4tCJmeJLjYnUL3g4Ua2VEeH2N14K3qq9p6Cv47vTwrSZxLXcQtlenm7mRmP447VTTtTVrqxtb9bHcrm8Z/mvrWz5xvv6+5bRfe99y1laOsZq5iF6JiZmLZ30lJmqaTuxKTJT1pK7EREnJ3brfz9ZzmdTte7He5HLINKJssEFBbhrV0dhCodoGkeI0Nco87xx1+NfpSM8884nAb7lb9YveaNCEFox2o8FtzGhcRb12zzquItBdJxZXEeA6qbiKAFU7I+mPjaibKjQ2nvWdkOD4O7E7IUG2k7oTEiSjp5yA9w0tb6O+PXcIKVf5w/kyrDfekaBiTQFwt/M+Z45aiZB5MW8yNY1J5BrpGhShrUy8JIuEijcoajWmI3eskfWfbpS/PTX/VON+enr6eRlLz3l6BAnf1RtG6a43ENyoZz4dlvmzwyDWKJtLj3eLqqaE5NkO8c+TqlpT0mqER/IrIGo83eiOJFRAcE81sqejpi9yt+FgSh4hRhe5XA43itled4mJy9M+xAUhod3DkRwndcJoQHuQ8FkHtIdrdWIB7WG6kwpoD7ORB6CVIDN60S6ZHlM/EvqAl0kpPR0fdiI/JSkdpqs/uvKx9bcaXJFbIE7ZpxtT55EsUw0lLAl5BD2USHM3VD3ZkqCi3gkVZsZPgBoJvrTJaHlP1SVUcGhwll/XRxn7DZcx5uECTE7nGeHv1ycFV2cJ4s+hF8rJoFft8meH1ZO/jfotUTTDQ5YQ/S7kftbbjcbyG0GEdrnDGYF3yHlUJhT5ajKou4ctgYwkXB/hoEVnTmfhLdezbfZ+EUe9U4y37sjnQa7UaxziCWoghRRwl1mHqfYfaU0RGyT+5uadRefthFftd7CifBpouFLvYX1hOXpFFm8ngKfmV2yoZlAFZVY75ZgAy3YHQrP12CaXw1ZBKcdvmpTYCSBqy1FKafysIbhDbaXqzqIxsrV1SKIYAkthZgmQzAjWScgaQjKTU0ArIOdstVQMNgr5dEAtugxRAIamsLMEcwbvzI3abZ0kfYt5cTDayfsyN/7HyqyKvyUyLPwHrUK8EsRVfOWqkA8I4XYwB+IlIVH571hGydUlpPAW6JEArOTjSSWVv5BQLmTxFOqRNHfVoDSL33Crhr2Nvnqz4TnzMJenickYdYk3esX7VMIRo0e2/b6ip9yTxzfC8QIUazmrsm21HmkmMaJ4/Qd5NlIv4vnDTPyUGLB/YYI2s+69RTkWnq81s1QmhNAvWArx2+rW/ffiakEO/QYrQ2i934npJWg9XIdVYTdXrfDdRrVSDKv3oQLoEv8gpZpQ6iOBQbSyksNqPugWVTc5JoQQurRCPF1aLYceEwyRHhNSCq91sl7oRmjWKqSwWo+lvC7u9xOKKaOYQ7TmxlGsxNA9l8OPY9MWjT2n5bCaH2mELrX1RHeDckLJjyUo3dpGED1HcniGJjlHhBC+pbl4eo5oOfRoZoj0HJFS6DboQ5LNTK7TG9tACKF1wpPcvWS7CiF0uwrxdLtqOXS7MkS6XaUURWs1TtoeKYWeDVI+PRuMINr2cEja9igxQkvAwgnRElyK0BJcHtMSSpDQEgDBtIQQQ88LQOkVSuO8EEL4J/O5eHpeaDn8W/mASM8LKYVug+2ycXMlfoquev/GtOWQPUDd1JZSlRBC13h8P88HuXz7ol5jqVRKoUfTSp71zKth36vvIqReJUfYQnSsRmhWLKTso4Pk3kdAYP8t9z4/SChnknj1HwiQeP/OkAR2cQ6JkSdsZVftPv1+I4MUozTSE4lxnBwvpRhqPo0UzcPFwY54IV5FhX5HOFJc9ZYUKSChM1kfdatCJ6h5PqTcCJEyp9wZjDzt3w1pt8Uo+h+IASFVnwqqFhKk4ybuluI6v/QMFP8lap/+ry4b+CwLeIelyUAJVVIIa0re38yFOf5tgz74HW2WwPNsmaW6tRMalRRJbTnoyyd8Y2qZFFrt/aqwnl5sUqukWtrmgHkQepUYxTwcvuMUuVG3EqPortsEd9oKzS1NwoedMazwwAE7vAWTaKNQE+yHAYqaKMlXy528wnD+Jqic/UyyOAJyN+tP1CmiayxtxUJqKmP5XEj5s7KVoZI/E1P525BiuqE8hsv/Ayt+8zeetTQ/Y3Mb7633J+pDUZvhljomhndawU390UamAu5eiCnWsljte70qu48oMRND6zSFjeqklPP9jWaLbKvEW+T9UTfTa9qYTi6H12pCI+Na3XjIxGbxKgwY25UfWKVZuo003iI/nVNDx+Y5H+XxIITl+TUYTvj6GGnK6YdXlTiFkcZTHC30d22GF+MMSpjwleywoWdTnI5SWOIUEjYSCSRGnLBhWtUK7GOvC1EmH0PY2czzvf2CnH+ye5yvhsXjCpNioTpcmXdO/rwKFpHHtp4QPg7ZA66dl0Y1rn/NWoelXqj3oKvQQnLF/4M4CZes8xz38mGVw7vXeS841rIN6G/7Afpv+zbyjCWC9uGv55Dhz3nYvnZYe8aWwSr+tMvDW3hc4bViBJq7W2p182KNISiMpXoCW59Z8WwU/Jda+9U4XCn09wNgEiP3miHFUgKtdCsbJZQaCfRqpxxcy0cQ0iS+9rV94hn9O9opVg6W4PBRlPHvAvr4r+hKQ6BHotJGAr1ggmOfe8KjWNPGfsLq+bWenlAAaKRJF5bGjnenbnDPRDCE1YMa8A5b3aN3xpMjMAQnYYChcf6lV0CqJezY42/bXw3TWPRQ4ycaa8UcOz4fo50cYvzYMcz1TZJRzX4nxRXDxtj5jv6do9f6FaP1yUq+wVKwgvjbIPjHmT//5YUHyxApAcG2v7x0dAuiNqHjuvkvL+/NDybbv7p44fBuVhXMvfCrVy4dKqr3z1+4vD/H9L9/4eVXjhbVIHj/5fMXHlrjeO/8uQuXDllr5tV4d+/CuUuXD5by8VbZ27944dVXLh/xdUwO6IMLr1w4f+nS4WwXhtKorB5cOPfaq+dfvnDE2mu2X2SjB5fOv3bp4rlLR1CFHGrTzR9cvnj58ivnLh9egzfVIMp5rGryDVORb/J6fEvX4pSuwxVRgX/8hSk+jFC79L/7xowu++++OSNL/rtvzZhi/+4XM7rIv5/55syMKS/vBFPY389cga5QJf39zC9mZh6P4ExUT0WI+D3cmPT7rOh/v98vtovxnz6RYW1a5E+ORMQQ/Nc/PBltlfeX+JaZZfD5+0fsTs56Vt0sBveY6K+v5dvlqdOn5mEZMRgXWf+UWEOcmu8s/eH1rfF4OHr97NlNCM6drJ+BcHEWr75VDt4dnWYRdad7gD4LFRPY02K8nc5H20/Yhh9aebnKh/mg94dTvbI7Os0y31nofrF+NhsWp9lv/ww='; \ No newline at end of file diff --git a/docs/assets/dmt/dmt-components.css b/docs/assets/dmt/dmt-components.css index 9748cae..7865769 100644 --- a/docs/assets/dmt/dmt-components.css +++ b/docs/assets/dmt/dmt-components.css @@ -1,7 +1,7 @@ label.svelte-1y7unmi{align-items:center;cursor:pointer;display:flex;-webkit-user-select:none;user-select:none;width:fit-content}input.svelte-1y7unmi{cursor:pointer;height:1.5em;opacity:0;position:absolute;width:1.5em}svg.svelte-1y7unmi{border-radius:.33em;cursor:pointer;height:1.5em;margin-right:.5em;opacity:.99;width:1.5em} section.svelte-20evnz{display:flex;flex-direction:column;gap:.5rem;margin-top:.75rem} -details.svelte-1kxmj7q.svelte-1kxmj7q{margin-left:var(--tjs-folder-details-margin-left,-.4em);padding-left:var(--tjs-folder-details-padding-left,.4em)}summary.svelte-1kxmj7q.svelte-1kxmj7q{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;-moz-user-select:none;user-select:none;width:var(--tjs-folder-summary-width,-moz-fit-content);width:var(--tjs-folder-summary-width,fit-content)}summary.svelte-1kxmj7q.svelte-1kxmj7q::-webkit-details-marker{display:none}.default-cursor.svelte-1kxmj7q.svelte-1kxmj7q{cursor:default}summary.svelte-1kxmj7q svg.svelte-1kxmj7q{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.disabled.svelte-1kxmj7q.svelte-1kxmj7q{color:var(--tjs-folder-summary-disabled-color,inherit);cursor:var(--tjs-folder-summary-disabled-cursor,default)}summary.disabled.svelte-1kxmj7q svg.svelte-1kxmj7q{color:var(--tjs-folder-summary-disabled-color,currentColor);cursor:var(--tjs-folder-summary-disabled-cursor,default)}summary.svelte-1kxmj7q.svelte-1kxmj7q: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-1kxmj7q:focus-visible .label.svelte-1kxmj7q{text-shadow:var(--tjs-folder-summary-label-text-shadow-focus-visible,var(--tjs-default-text-shadow-focus-hover,revert))}summary.svelte-1kxmj7q:focus-visible .tjs-folder-focus-indicator.svelte-1kxmj7q{background:var(--tjs-folder-summary-focus-indicator-background,var(--tjs-default-focus-indicator-background,#fff))}summary.svelte-1kxmj7q:focus-visible svg.svelte-1kxmj7q{opacity:var(--tjs-folder-summary-chevron-opacity-focus-visible,1)}summary.svelte-1kxmj7q:focus-visible svg.focus-chevron.svelte-1kxmj7q{outline:var(--tjs-folder-summary-outline-focus-visible,var(--tjs-default-outline-focus-visible,revert))}summary:focus-visible.remove-focus-visible.svelte-1kxmj7q.svelte-1kxmj7q{outline:none}summary.svelte-1kxmj7q:hover:not(.disabled) svg.svelte-1kxmj7q{opacity:var(--tjs-folder-summary-chevron-opacity-hover,1)}.tjs-folder-focus-indicator.svelte-1kxmj7q.svelte-1kxmj7q{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-1kxmj7q>summary.svelte-1kxmj7q{background:var(--tjs-folder-summary-background-open,var(--tjs-folder-summary-background,inherit))}[open].svelte-1kxmj7q:not(details[data-closing=true])>summary svg.svelte-1kxmj7q{transform:rotate(var(--tjs-folder-summary-chevron-rotate-open,0))}.contents.svelte-1kxmj7q.svelte-1kxmj7q{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-1kxmj7q.svelte-1kxmj7q:before{content:"";height:calc(100% + .65em);left:0;position:absolute;top:-.65em;width:0}.contents.hidden.svelte-1kxmj7q.svelte-1kxmj7q{display:none}.label.svelte-1kxmj7q.svelte-1kxmj7q{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,-moz-fit-content);width:var(--tjs-folder-summary-label-width,fit-content)}summary.svelte-1kxmj7q:focus-visible+.contents.svelte-1kxmj7q:before{height:100%;top:0} -details.svelte-ozx17m.svelte-ozx17m{margin-left:var(--tjs-folder-details-margin-left,-.4em);padding-left:var(--tjs-folder-details-padding-left,.4em)}summary.svelte-ozx17m.svelte-ozx17m{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);padding:var(--tjs-folder-summary-padding,.25em) 0;position:relative;transition:var(--tjs-folder-summary-transition,background .1s);-webkit-user-select:none;-moz-user-select:none;user-select:none;width:var(--tjs-folder-summary-width,-moz-fit-content);width:var(--tjs-folder-summary-width,fit-content)}summary.svelte-ozx17m.svelte-ozx17m::-webkit-details-marker{display:none}summary.svelte-ozx17m i.svelte-ozx17m{border-radius:var(--tjs-folder-summary-chevron-border-radius,0);color:var(--tjs-folder-summary-chevron-color,inherit);cursor:var(--tjs-folder-summary-cursor,pointer);flex-shrink:0;margin:var(--tjs-folder-summary-chevron-margin,0 0 0 .25em);opacity:var(--tjs-folder-summary-chevron-opacity,1);transition:var(--tjs-folder-summary-chevron-transition,opacity .2s,transform .1s);width:var(--tjs-folder-summary-chevron-width,1.25em)}summary.disabled.svelte-ozx17m i.svelte-ozx17m,summary.disabled.svelte-ozx17m.svelte-ozx17m{color:var(--tjs-folder-summary-disabled-color,inherit);cursor:var(--tjs-folder-summary-disabled-cursor,default)}summary.svelte-ozx17m.svelte-ozx17m: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-ozx17m:focus-visible .label.svelte-ozx17m{text-shadow:var(--tjs-folder-summary-label-text-shadow-focus-visible,var(--tjs-default-text-shadow-focus-hover,revert))}summary.svelte-ozx17m:focus-visible .tjs-folder-focus-indicator.svelte-ozx17m{background:var(--tjs-folder-summary-focus-indicator-background,var(--tjs-default-focus-indicator-background,#fff))}summary.svelte-ozx17m:focus-visible i.svelte-ozx17m{opacity:var(--tjs-folder-summary-chevron-opacity-focus-visible,1)}summary.svelte-ozx17m:focus-visible i.focus-chevron.svelte-ozx17m:before{outline:var(--tjs-folder-summary-outline-focus-visible,var(--tjs-default-outline-focus-visible,revert))}summary:focus-visible.remove-focus-visible.svelte-ozx17m.svelte-ozx17m{outline:none}summary.svelte-ozx17m:hover i.svelte-ozx17m{opacity:var(--tjs-folder-summary-chevron-opacity-hover,1)}.tjs-folder-focus-indicator.svelte-ozx17m.svelte-ozx17m{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))}.default-cursor.svelte-ozx17m.svelte-ozx17m{cursor:default}details[open].svelte-ozx17m>summary.svelte-ozx17m{background:var(--tjs-folder-summary-background-open,var(--tjs-folder-summary-background,inherit))}.contents.svelte-ozx17m.svelte-ozx17m{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-ozx17m.svelte-ozx17m:before{content:"";height:calc(100% + .65em);left:0;position:absolute;top:-.65em;width:0}.contents.hidden.svelte-ozx17m.svelte-ozx17m{display:none}.label.svelte-ozx17m.svelte-ozx17m{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,-moz-fit-content);width:var(--tjs-folder-summary-label-width,fit-content)}summary.svelte-ozx17m:focus-visible+.contents.svelte-ozx17m:before{height:100%;top:0} +details.svelte-1kxmj7q.svelte-1kxmj7q{margin-left:var(--tjs-folder-details-margin-left,-.4em);padding-left:var(--tjs-folder-details-padding-left,.4em)}summary.svelte-1kxmj7q.svelte-1kxmj7q{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-1kxmj7q.svelte-1kxmj7q::-webkit-details-marker{display:none}.default-cursor.svelte-1kxmj7q.svelte-1kxmj7q{cursor:default}summary.svelte-1kxmj7q svg.svelte-1kxmj7q{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.disabled.svelte-1kxmj7q.svelte-1kxmj7q{color:var(--tjs-folder-summary-disabled-color,inherit);cursor:var(--tjs-folder-summary-disabled-cursor,default)}summary.disabled.svelte-1kxmj7q svg.svelte-1kxmj7q{color:var(--tjs-folder-summary-disabled-color,currentColor);cursor:var(--tjs-folder-summary-disabled-cursor,default)}summary.svelte-1kxmj7q.svelte-1kxmj7q: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-1kxmj7q:focus-visible .label.svelte-1kxmj7q{text-shadow:var(--tjs-folder-summary-label-text-shadow-focus-visible,var(--tjs-default-text-shadow-focus-hover,revert))}summary.svelte-1kxmj7q:focus-visible .tjs-folder-focus-indicator.svelte-1kxmj7q{background:var(--tjs-folder-summary-focus-indicator-background,var(--tjs-default-focus-indicator-background,#fff))}summary.svelte-1kxmj7q:focus-visible svg.svelte-1kxmj7q{opacity:var(--tjs-folder-summary-chevron-opacity-focus-visible,1)}summary.svelte-1kxmj7q:focus-visible svg.focus-chevron.svelte-1kxmj7q{outline:var(--tjs-folder-summary-outline-focus-visible,var(--tjs-default-outline-focus-visible,revert))}summary:focus-visible.remove-focus-visible.svelte-1kxmj7q.svelte-1kxmj7q{outline:none}summary.svelte-1kxmj7q:hover:not(.disabled) svg.svelte-1kxmj7q{opacity:var(--tjs-folder-summary-chevron-opacity-hover,1)}.tjs-folder-focus-indicator.svelte-1kxmj7q.svelte-1kxmj7q{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-1kxmj7q>summary.svelte-1kxmj7q{background:var(--tjs-folder-summary-background-open,var(--tjs-folder-summary-background,inherit))}[open].svelte-1kxmj7q:not(details[data-closing=true])>summary svg.svelte-1kxmj7q{transform:rotate(var(--tjs-folder-summary-chevron-rotate-open,0))}.contents.svelte-1kxmj7q.svelte-1kxmj7q{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-1kxmj7q.svelte-1kxmj7q:before{content:"";height:calc(100% + .65em);left:0;position:absolute;top:-.65em;width:0}.contents.hidden.svelte-1kxmj7q.svelte-1kxmj7q{display:none}.label.svelte-1kxmj7q.svelte-1kxmj7q{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-1kxmj7q:focus-visible+.contents.svelte-1kxmj7q:before{height:100%;top:0} +details.svelte-ozx17m.svelte-ozx17m{margin-left:var(--tjs-folder-details-margin-left,-.4em);padding-left:var(--tjs-folder-details-padding-left,.4em)}summary.svelte-ozx17m.svelte-ozx17m{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);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-ozx17m.svelte-ozx17m::-webkit-details-marker{display:none}summary.svelte-ozx17m i.svelte-ozx17m{border-radius:var(--tjs-folder-summary-chevron-border-radius,0);color:var(--tjs-folder-summary-chevron-color,inherit);cursor:var(--tjs-folder-summary-cursor,pointer);flex-shrink:0;margin:var(--tjs-folder-summary-chevron-margin,0 0 0 .25em);opacity:var(--tjs-folder-summary-chevron-opacity,1);transition:var(--tjs-folder-summary-chevron-transition,opacity .2s,transform .1s);width:var(--tjs-folder-summary-chevron-width,1.25em)}summary.disabled.svelte-ozx17m i.svelte-ozx17m,summary.disabled.svelte-ozx17m.svelte-ozx17m{color:var(--tjs-folder-summary-disabled-color,inherit);cursor:var(--tjs-folder-summary-disabled-cursor,default)}summary.svelte-ozx17m.svelte-ozx17m: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-ozx17m:focus-visible .label.svelte-ozx17m{text-shadow:var(--tjs-folder-summary-label-text-shadow-focus-visible,var(--tjs-default-text-shadow-focus-hover,revert))}summary.svelte-ozx17m:focus-visible .tjs-folder-focus-indicator.svelte-ozx17m{background:var(--tjs-folder-summary-focus-indicator-background,var(--tjs-default-focus-indicator-background,#fff))}summary.svelte-ozx17m:focus-visible i.svelte-ozx17m{opacity:var(--tjs-folder-summary-chevron-opacity-focus-visible,1)}summary.svelte-ozx17m:focus-visible i.focus-chevron.svelte-ozx17m:before{outline:var(--tjs-folder-summary-outline-focus-visible,var(--tjs-default-outline-focus-visible,revert))}summary:focus-visible.remove-focus-visible.svelte-ozx17m.svelte-ozx17m{outline:none}summary.svelte-ozx17m:hover i.svelte-ozx17m{opacity:var(--tjs-folder-summary-chevron-opacity-hover,1)}.tjs-folder-focus-indicator.svelte-ozx17m.svelte-ozx17m{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))}.default-cursor.svelte-ozx17m.svelte-ozx17m{cursor:default}details[open].svelte-ozx17m>summary.svelte-ozx17m{background:var(--tjs-folder-summary-background-open,var(--tjs-folder-summary-background,inherit))}.contents.svelte-ozx17m.svelte-ozx17m{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-ozx17m.svelte-ozx17m:before{content:"";height:calc(100% + .65em);left:0;position:absolute;top:-.65em;width:0}.contents.hidden.svelte-ozx17m.svelte-ozx17m{display:none}.label.svelte-ozx17m.svelte-ozx17m{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-ozx17m:focus-visible+.contents.svelte-ozx17m:before{height:100%;top:0} 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} .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-wwxcg7{border:unset;border-bottom:var(--dmt-container-border);margin:.25rem .5rem 0 0}section.svelte-wwxcg7{--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;padding-bottom:.25rem} diff --git a/docs/assets/dmt/dmt-components.js b/docs/assets/dmt/dmt-components.js index 3ae810d..1bfca04 100644 --- a/docs/assets/dmt/dmt-components.js +++ b/docs/assets/dmt/dmt-components.js @@ -3,65 +3,65 @@ * @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 b{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((()=>(J(),this?this.unpack(e,i):b.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 b){if(c=this,this.structures)return r=this.structures,v(i);(!r||r.length>0)&&(r=[])}else c=h,(!r||r.length>0)&&(r=[]);return v(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 v(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(),J(),(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&&T()[63&e];return t?(t.read||(t.read=$(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):D(t);if(null!=e)return e}return E(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 U(t[l++]);case 200:return n=a.getUint16(l),l+=2,U(n);case 201:return n=a.getUint32(l),l+=4,U(n);case 202:if(n=a.getFloat32(l),c.useFloat32>2){let e=K[(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):C(n);case 218:return n=a.getUint16(l),f>=(l+=2)?o.slice(l-u,(l+=n)-u):I(n);case 219:return n=a.getUint32(l),f>=(l+=4)?o.slice(l-u,(l+=n)-u):L(n);case 220:return n=a.getUint16(l),l+=2,O(n);case 221:return n=a.getUint32(l),l+=4,O(n);case 222:return n=a.getUint16(l),l+=2,A(n);case 223:return n=a.getUint32(l),l+=4,A(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 S=/^[a-zA-Z_$][a-zA-Z\d_$]*$/;function $(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()":S.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]||T()[s];if(!i)throw new Error("Record id is not defined for "+s);return i.read||(i.read=$(i,e)),i.read()};function T(){let e=W((()=>(t=null,c.getStructures())));return r=c._mergeStructures(e,r)}var E=P,C=P,I=P,L=P;function P(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+=M.apply(String,s),s.length=0)}return s.length>0&&(r+=M.apply(String,s)),r}function O(e){let t=new Array(e);for(let n=0;n0)return void(l=n);r[o]=e}return M.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):M(e)}}{let n=t[l++],r=t[l++];if((128&n)>0||(128&r)>0)return void(l-=2);if(e<3)return M(n,r);let o=t[l++];return(128&o)>0?void(l-=3):M(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 M(n,r,o,s);{let e=t[l++];return(128&e)>0?void(l-=5):M(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 M(n,r,o,s,i,a);let c=t[l++];return(128&c)>0?void(l-=7):M(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 M(n,r,o,s,i,a,c,u);{let e=t[l++];return(128&e)>0?void(l-=9):M(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 M(n,r,o,s,i,a,c,u,f,d);let h=t[l++];return(128&h)>0?void(l-=11):M(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 M(n,r,o,s,i,a,c,u,f,d,h,p);{let e=t[l++];return(128&e)>0?void(l-=13):M(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 M(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):M(n,r,o,s,i,a,c,u,f,d,h,p,g,m,y)}}}}}function F(){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 P(e)}function N(e){return c.copyBuffers?Uint8Array.prototype.slice.call(t,l,l+=e):t.subarray(l,l+=e)}function U(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 j=new Array(4096);function B(){let e=t[l++];if(!(e>=160&&e<192))return l--,_(x());if(e-=160,f>=l)return o.slice(l-u,(l+=e)-u);if(!(0==f&&n<180))return E(e);let r,s=4095&(e<<5^(e>1?a.getUint16(l):e>0?t[l]:0)),i=j[s],c=l,d=l+e-3,h=0;if(i&&i.bytes==e){for(;c{let n=x().map(_),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=$(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],{cause:e[2]})},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 q="object"==typeof globalThis?globalThis:window;d[116]=e=>{let t=e[0],n=H[t];if(!n){if(16===t){let t=new ArrayBuffer(e.length-1);return new Uint8Array(t).set(e.subarray(1)),t}throw new Error("Could not find typed array for code "+t)}return new q[n](Uint8Array.prototype.slice.call(e,1).buffer)},d[120]=()=>{let e=x();return new RegExp(e[0],e[1])};const V=[];function W(e){let d=n,h=l,p=u,g=f,y=o,b=i,v=s,w=new Uint8Array(t.slice(0,n)),x=r,S=r.slice(0,r.length),$=c,k=m,T=e();return n=d,l=h,u=p,f=g,o=y,i=b,s=v,t=w,m=k,(r=x).splice(0,r.length,...S),c=$,a=new DataView(t.buffer,t.byteOffset,t.byteLength),T}function J(){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=V,(s=[F(),F()]).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 K=new Array(147);for(let e=0;e<256;e++)K[e]=+("1e"+Math.floor(45.15-.30103*e));var G=new b({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,e.buffer||(e=new Uint8Array(e)),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,e.cause])}},{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 be=new class extends b{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,ie.byteLength-t)}:!(!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&ve?(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,ie.length>1073741824&&(ie=null),o)}ie.length>1073741824&&(ie=null),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,v,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 v(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*K[(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)$(e);else if(s===Array)b(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)v(t),v(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})),v)}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))b(e);else{if(e.toJSON){const t=e.toJSON();if(t!==e)return v(t)}if("function"===r)return v(this.writeFunction&&this.writeFunction(e));$(e)}}}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.largeBigIntToString)return v(e.toString());if(this.useBigIntExtension&&e-(BigInt(2)**BigInt(1023))){ie[ue++]=199,ue++,ie[ue++]=66;let t,n=[];do{let r=e&BigInt(255);t=(r&BigInt(128))===(e>=BigInt(8)}while(e!==BigInt(0)&&e!==BigInt(-1)||!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, or set largeBigIntToString to convert to string")}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||this.skipValues?e=>{let t;if(this.skipValues){t=[];for(let n in e)"function"==typeof e.hasOwnProperty&&!e.hasOwnProperty(n)||this.skipValues.includes(e[n])||t.push(n)}else t=Object.keys(e);let n,r=t.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 n=ue-t;ue+=2;let r=0;for(let t in e)("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(t))&&(v(t),v(e[t]),r++);if(r>65535)throw new Error('Object is too large to serialize with fast 16-bit map size, use the "variableMapSize" option to serialize this object');ie[n+++t]=r>>8,ie[n+t]=255&r},x=!1===this.useRecords?w:e.progressiveRecords&&!f?e=>{let n,o,s=r.transitions||(r.transitions=Object.create(null)),i=ue++-t;for(let a in e)if("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(a)){if(n=s[a],n)s=n;else{let l=Object.keys(e),c=s;s=r.transitions;let u=0;for(let e=0,t=l.length;e{let t,n=r.transitions||(r.transitions=Object.create(null)),o=0;for(let r in e)("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(r))&&(t=n[r],t||(t=n[r]=Object.create(null),o++),n=t);let s=n[he];s?s>=96&&f?(ie[ue++]=96+(31&(s-=96)),ie[ue++]=s>>5):ie[ue++]=s:T(n,n.__keys__||Object.keys(e),o);for(let t in e)("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(t))&&v(e[t])},S="function"==typeof this.useRecords&&this.useRecords,$=S?e=>{S(e)?x(e):w(e)}: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},T=(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),v(t))},E=(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,T(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]},C=e=>{let o=undefined(e,ie,t,ue,r,k,((e,t,r)=>{if(r)return n=!0;ue=t;let o=ie;return v(e),y(),o!==ie?{position:ue,targetView:le,target:ie}:ue}),this);if(0===o)return $(e);ue=o}}useBuffer(e){ie=e,ie.dataView||(ie.dataView=new DataView(ie.buffer,ie.byteOffset,ie.byteLength)),ue=0}set position(e){ue=e}get position(){return ue}clearSharedData(){this.structures&&(this.structures=[]),this.typedStructs&&(this.typedStructs=[])}}({useRecords:!1});be.pack,be.pack;const ve=512,we=1024,xe=2048;var Se=Uint8Array,$e=Uint16Array,ke=Int32Array,Te=new Se([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]),Ee=new Se([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]),Ce=new Se([16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15]),Ie=function(e,t){for(var n=new $e(31),r=0;r<31;++r)n[r]=t+=1<>1|(21845&De)<<1;Re=(61680&(Re=(52428&Re)>>2|(13107&Re)<<2))>>4|(3855&Re)<<4,Me[De]=((65280&Re)>>8|(255&Re)<<8)>>1}var Fe=function(e,t,n){for(var r=e.length,o=0,s=new $e(t);o>l]=c}else for(i=new $e(r),o=0;o>15-e[o]);return i},Ne=new Se(288);for(De=0;De<144;++De)Ne[De]=8;for(De=144;De<256;++De)Ne[De]=9;for(De=256;De<280;++De)Ne[De]=7;for(De=280;De<288;++De)Ne[De]=8;var Ue=new Se(32);for(De=0;De<32;++De)Ue[De]=5;var je=Fe(Ne,9,1),Be=Fe(Ue,5,1),_e=function(e){for(var t=e[0],n=1;nt&&(t=e[n]);return t},Qe=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"],qe=function(e,t,n){var r=new Error(t||He[e]);if(r.code=e,Error.captureStackTrace&&Error.captureStackTrace(r,qe),!n)throw r;return r},Ve=function(e,t,n,r){var o=e.length,s=r?r.length:0;if(!o||t.f&&!t.l)return n||new Se(0);var i=!n,a=i||2!=t.i,l=t.i;i&&(n=new Se(3*o));var c=function(e){var t=n.length;if(e>t){var r=new Se(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=Qe(e,f,1);var b=Qe(e,f+1,3);if(f+=3,!b){var v=e[(P=4+((f+7)/8|0))-4]|e[P-3]<<8,w=P+v;if(w>o){l&&qe(0);break}a&&c(d+v),n.set(e.subarray(P,w),d),t.b=d+=v,t.p=f=8*w,t.f=u;continue}if(1==b)h=je,p=Be,g=9,m=5;else if(2==b){var x=Qe(e,f,31)+257,S=Qe(e,f+10,15)+4,$=x+Qe(e,f+5,31)+1;f+=14;for(var k=new Se($),T=new Se(19),E=0;E>4)<16)k[E++]=P;else{var A=0,M=0;for(16==P?(M=3+Qe(e,f,3),f+=2,A=k[E-1]):17==P?(M=3+Qe(e,f,7),f+=3):18==P&&(M=11+Qe(e,f,127),f+=7);M--;)k[E++]=A}}var D=k.subarray(0,x),R=k.subarray(x);g=_e(D),m=_e(R),h=Fe(D,g,1),p=Fe(R,m,1)}else qe(1);if(f>y){l&&qe(0);break}}a&&c(d+131072);for(var F=(1<>4;if((f+=15&A)>y){l&&qe(0);break}if(A||qe(2),j<256)n[d++]=j;else{if(256==j){U=f,h=null;break}var B=j-254;if(j>264){var _=Te[E=j-257];B=Qe(e,f,(1<<_)-1)+Pe[E],f+=_}var Q=p[ze(e,f)&N],z=Q>>4;Q||qe(3),f+=15&Q;R=Ae[z];if(z>3){_=Ee[z];R+=ze(e,f)&(1<<_)-1,f+=_}if(f>y){l&&qe(0);break}a&&c(d+131072);var H=d+B;if(de.length)&&(n=e.length),new Se(e.subarray(t,n))}(n,0,d):n.subarray(0,d)},We=new Se(0);function Je(e,t){return Ve(e,{i:2},t&&t.out,t&&t.dictionary)}var Ke="undefined"!=typeof TextDecoder&&new TextDecoder;try{Ke.decode(We,{stream:!0})}catch(e){}const Ge="function"==typeof Buffer;"function"==typeof TextDecoder&&new TextDecoder,"function"==typeof TextEncoder&&new TextEncoder;const Ze=Array.prototype.slice.call("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="),Ye=(()=>{let e={};return Ze.forEach(((t,n)=>e[t]=n)),e})(),Xe=/^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/,et=String.fromCharCode.bind(String),tt="function"==typeof Uint8Array.from?Uint8Array.from.bind(Uint8Array):e=>new Uint8Array(Array.prototype.slice.call(e,0)),nt=e=>e.replace(/[^A-Za-z0-9\+\/]/g,""),rt="function"==typeof atob?e=>atob(nt(e)):Ge?e=>Buffer.from(e,"base64").toString("binary"):e=>{if(e=e.replace(/\s+/g,""),!Xe.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?et(t>>16&255,t>>8&255):et(t>>16&255,t>>8&255,255&t);return o},ot=Ge?e=>tt(Buffer.from(e,"base64")):e=>tt(rt(e).split("").map((e=>e.charCodeAt(0)))),st=e=>nt(e.replace(/[-_]/g,(e=>"-"==e?"+":"/")));function it(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 at(e){if(null==e)return!1;switch(typeof e){case"function":case"object":return"function"==typeof e.subscribe&&"function"==typeof e.set&&"function"==typeof e.update}return!1}function lt(e,t,n){let r=!1;return e.subscribe((e=>{r?n(e):(r=!0,t(e))}))}function ct(e){return null!=e&&"object"==typeof e&&Symbol.iterator in e}function ut(e){return null!==e&&"object"==typeof e&&!Array.isArray(e)}function ft(e,t,n){if("object"!=typeof e)return n;if("string"!=typeof t)return n;const r=t.split(".");for(let t=0;t{for(const t of e){const e=this.#t.get(t?.target);if(Array.isArray(e)){const n=t.contentRect.width,r=t.contentRect.height;for(const t of e)ht.#o(t,n,r)}}}))}add(e,t){if(!(e instanceof HTMLElement))throw new TypeError("ResizeObserverManager.add error: 'el' is not a HTMLElement.");if(this.#s(e,t))return;const n=ht.#i(t);if(0===n)throw new Error("ResizeObserverManager.add error: 'target' is not a valid ResizeObserverManager target.");const r=globalThis.getComputedStyle(e),o=dt.pixels(e.style.borderBottom)??dt.pixels(r.borderBottom)??0,s=dt.pixels(e.style.borderLeft)??dt.pixels(r.borderLeft)??0,i=dt.pixels(e.style.borderRight)??dt.pixels(r.borderRight)??0,a=dt.pixels(e.style.borderTop)??dt.pixels(r.borderTop)??0,l=dt.pixels(e.style.paddingBottom)??dt.pixels(r.paddingBottom)??0,c={updateType:n,target:t,contentWidth:0,contentHeight:0,styles:{additionalWidth:s+i+(dt.pixels(e.style.paddingLeft)??dt.pixels(r.paddingLeft)??0)+(dt.pixels(e.style.paddingRight)??dt.pixels(r.paddingRight)??0),additionalHeight:a+o+(dt.pixels(e.style.paddingTop)??dt.pixels(r.paddingTop)??0)+l}};if(this.#t.has(e)){this.#t.get(e).push(c)}else this.#t.set(e,[c]);this.#n.observe(e)}clear(){for(const e of this.#t.keys())this.#n.unobserve(e);this.#t.clear()}remove(e,t=void 0){const n=this.#t.get(e);if(Array.isArray(n)){if(void 0!==t){const e=n.findIndex((e=>e.target===t));e>=0&&n.splice(e,1)}else n.length=0;0===n.length&&(this.#t.delete(e),this.#n.unobserve(e))}}updateCache(e){const t=this.#t.get(e);if(Array.isArray(t)){const n=globalThis.getComputedStyle(e),r=dt.pixels(e.style.borderBottom)??dt.pixels(n.borderBottom)??0,o=dt.pixels(e.style.borderLeft)??dt.pixels(n.borderLeft)??0,s=dt.pixels(e.style.borderRight)??dt.pixels(n.borderRight)??0,i=dt.pixels(e.style.borderTop)??dt.pixels(n.borderTop)??0,a=dt.pixels(e.style.paddingBottom)??dt.pixels(n.paddingBottom)??0,l=o+s+(dt.pixels(e.style.paddingLeft)??dt.pixels(n.paddingLeft)??0)+(dt.pixels(e.style.paddingRight)??dt.pixels(n.paddingRight)??0),c=i+r+(dt.pixels(e.style.paddingTop)??dt.pixels(n.paddingTop)??0)+a;for(const e of t)e.styles.additionalWidth=l,e.styles.additionalHeight=c,ht.#o(e,e.contentWidth,e.contentHeight)}}static#i(e){if("function"==typeof e?.resizeObserved)return this.#r.resizeObserved;if("function"==typeof e?.setDimension)return this.#r.setDimension;if("function"==typeof e?.setContentBounds)return this.#r.setContentBounds;const t=typeof e;if(null!==t&&("object"===t||"function"===t)){if(at(e.resizeObserved))return this.#r.storeObject;const t=e?.stores;if((ut(t)||"function"==typeof t)&&at(t.resizeObserved))return this.#r.storesObject}return null!==t&&"object"===t?this.#r.attribute:"function"===t?this.#r.function:this.#r.none}#s(e,t){if(null==t)return!1;const n=this.#t.get(e);return!!Array.isArray(n)&&n.findIndex((e=>e.target===t))>=0}static#o(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 this.#r.attribute:i.contentWidth=t,i.contentHeight=n,i.offsetWidth=o,i.offsetHeight=s;break;case this.#r.function:i?.(o,s,t,n);break;case this.#r.resizeObserved:i.resizeObserved?.(o,s,t,n);break;case this.#r.setContentBounds:i.setContentBounds?.(t,n);break;case this.#r.setDimension:i.setDimension?.(o,s);break;case this.#r.storeObject:i.resizeObserved.update((e=>(e.contentHeight=n,e.contentWidth=t,e.offsetHeight=s,e.offsetWidth=o,e)));break;case this.#r.storesObject:i.stores.resizeObserved.update((e=>(e.contentHeight=n,e.contentWidth=t,e.offsetHeight=s,e.offsetWidth=o,e)))}}}const pt=new ht;function gt(e,t){return pt.add(e,t),{update:n=>{pt.remove(e,t),t=n,pt.add(e,t)},destroy:()=>{pt.remove(e,t)}}}gt.updateCache=function(e){pt.updateCache(e)};class mt{constructor(){throw new Error("Timing constructor: This is a static class and should not be constructed.")}static debounce(e,t){if("function"!=typeof e)throw new TypeError("'callback' must be a function.");if(!Number.isInteger(t)||t<0)throw new TypeError("'delay' must be a positive integer representing milliseconds.");let n;return function(...r){globalThis.clearTimeout(n),n=globalThis.setTimeout((()=>{e.apply(this,r)}),t)}}static doubleClick({single:e,double:t,delay:n=400}){if(void 0!==e&&"function"!=typeof e)throw new TypeError("'single' must be a function.");if(void 0!==t&&"function"!=typeof t)throw new TypeError("'double' must be a function.");if(!Number.isInteger(n)||n<0)throw new TypeError("'delay' must be a positive integer representing milliseconds.");let r,o=0;return s=>{globalThis.clearTimeout(r),o++,1===o?r=globalThis.setTimeout((()=>{"function"==typeof e&&e(s),o=0}),n):("function"==typeof t&&t(s),o=0)}}}function yt(){}const bt=e=>e;function vt(e,t){for(const n in t)e[n]=t[n];return e}function wt(e){return e()}function xt(){return Object.create(null)}function St(e){e.forEach(wt)}function $t(e){return"function"==typeof e}function kt(e,t){return e!=e?t==t:e!==t||e&&"object"==typeof e||"function"==typeof e}let Tt;function Et(e,t){return e===t||(Tt||(Tt=document.createElement("a")),Tt.href=t,e===Tt.href)}function Ct(e,...t){if(null==e){for(const e of t)e(void 0);return yt}const n=e.subscribe(...t);return n.unsubscribe?()=>n.unsubscribe():n}function It(e){let t;return Ct(e,(e=>t=e))(),t}function Lt(e,t,n){e.$$.on_destroy.push(Ct(t,n))}function Pt(e,t,n,r){if(e){const o=Ot(e,t,n,r);return e[0](o)}}function Ot(e,t,n,r){return e[1]&&r?vt(n.ctx.slice(),e[1](r(t))):n.ctx}function At(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(),Bt=Ut?e=>requestAnimationFrame(e):yt;const _t=new Set;function Qt(e){_t.forEach((t=>{t.c(e)||(_t.delete(t),t.f())})),0!==_t.size&&Bt(Qt)}const zt="undefined"!=typeof window?window:"undefined"!=typeof globalThis?globalThis:global;function Ht(e,t){e.appendChild(t)}function qt(e){if(!e)return document;const t=e.getRootNode?e.getRootNode():e.ownerDocument;return t&&t.host?t:e.ownerDocument}function Vt(e){const t=Kt("style");return t.textContent="/* empty */",function(e,t){Ht(e.head||e,t),t.sheet}(qt(e),t),t.sheet}function Wt(e,t,n){e.insertBefore(t,n||null)}function Jt(e){e.parentNode&&e.parentNode.removeChild(e)}function Kt(e){return document.createElement(e)}function Gt(e){return document.createElementNS("http://www.w3.org/2000/svg",e)}function Zt(e){return document.createTextNode(e)}function Yt(){return Zt(" ")}function Xt(){return Zt("")}function en(e,t,n,r){return e.addEventListener(t,n,r),()=>e.removeEventListener(t,n,r)}function tn(e){return function(t){return t.stopPropagation(),e.call(this,t)}}function nn(e,t,n){null==n?e.removeAttribute(t):e.getAttribute(t)!==n&&e.setAttribute(t,n)}function rn(e,t){t=""+t,e.data!==t&&(e.data=t)}function on(e,t){e.value=null==t?"":t}function sn(e,t,n,r){null==n?e.style.removeProperty(t):e.style.setProperty(t,n,"")}function an(e,t,n){e.classList.toggle(t,!!n)}function ln(e,t){return new e(t)}const cn=new Map;let un,fn=0;function dn(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=qt(e),{stylesheet:h,rules:p}=cn.get(d)||function(e,t){const n={stylesheet:Vt(t),rules:{}};return cn.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`,fn+=1,f}function hn(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(", "),fn-=o,fn||Bt((()=>{fn||(cn.forEach((e=>{const{ownerNode:t}=e.stylesheet;t&&Jt(t)})),cn.clear())})))}function pn(e){un=e}function gn(){if(!un)throw new Error("Function called outside component initialization");return un}function mn(e){gn().$$.on_mount.push(e)}function yn(e,t){return gn().$$.context.set(e,t),t}function bn(e){return gn().$$.context.get(e)}function vn(e,t){const n=e.$$.callbacks[t.type];n&&n.slice().forEach((e=>e.call(this,t)))}const wn=[],xn=[];let Sn=[];const $n=[],kn=Promise.resolve();let Tn=!1;function En(){Tn||(Tn=!0,kn.then(An))}function Cn(){return En(),kn}function In(e){Sn.push(e)}const Ln=new Set;let Pn,On=0;function An(){if(0!==On)return;const e=un;do{try{for(;On{Rn.delete(e),r&&(n&&e.d(1),r())})),e.o(t)}else r&&r()}const _n={duration:0};function Qn(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&&hn(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=bt,tick:h=yt,css:p}=s||_n,g={start:jt()+n,b:t};t||(g.group=Fn,Fn.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=dn(e,i,t,r,n,d,p)),t&&h(0,1),a=f(g,r),In((()=>Dn(e,t,"start"))),function(e){let t;0===_t.size&&Bt(Qt),new Promise((n=>{_t.add(t={c:e,f:n})}))}((t=>{if(l&&t>l.start&&(a=f(l,r),l=null,Dn(e,a.b,"start"),p&&(u(),c=dn(e,i,a.b,a.duration,0,d,s.css))),a)if(t>=a.end)h(i=a.b,1-i),Dn(e,a.b,"end"),l||(a.b?u():--a.group.r||St(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){$t(s)?(Pn||(Pn=Promise.resolve(),Pn.then((()=>{Pn=null}))),Pn).then((()=>{s=s({direction:e?"in":"out"}),d(e)})):d(e)},end(){u(),a=l=null}}}function zn(e){return void 0!==e?.length?e:Array.from(e)}function Hn(e,t){e.d(1),t.delete(e.key)}function qn(e,t){Bn(e,1,1,(()=>{t.delete(e.key)}))}function Vn(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,b=new Map,v=[];for(p=h;p--;){const e=f(o,s,p),r=n(e);let a=i.get(r);a?v.push((()=>a.p(e,t))):(a=c(r,e),a.c()),y.set(r,m[p]=a),r in g&&b.set(r,Math.abs(p-g[r]))}const w=new Set,x=new Set;function S(e){jn(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)?S(t):x.has(o)?d--:b.get(r)>b.get(o)?(x.add(r),S(t)):(w.add(o),d--):(l(n,i),d--)}for(;d--;){const t=e[d];y.has(t.key)||l(t,i)}for(;h;)S(m[h-1]);return St(v),m}function Wn(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 Jn(e){return"object"==typeof e&&null!==e?e:{}}function Kn(e){e&&e.c()}function Gn(e,t,n){const{fragment:r,after_update:o}=e.$$;r&&r.m(t,n),In((()=>{const t=e.$$.on_mount.map(wt).filter($t);e.$$.on_destroy?e.$$.on_destroy.push(...t):St(t),e.$$.on_mount=[]})),o.forEach(In)}function Zn(e,t){const n=e.$$;null!==n.fragment&&(!function(e){const t=[],n=[];Sn.forEach((r=>-1===e.indexOf(r)?t.push(r):n.push(r))),n.forEach((e=>e())),Sn=t}(n.after_update),St(n.on_destroy),n.fragment&&n.fragment.d(t),n.on_destroy=n.fragment=null,n.ctx=[])}function Yn(e,t,n,r,o,s,i=null,a=[-1]){const l=un;pn(e);const c=e.$$={fragment:null,ctx:[],props:s,update:yt,not_equal:o,bound:xt(),on_mount:[],on_destroy:[],on_disconnect:[],before_update:[],after_update:[],context:new Map(t.context||(l?l.$$.context:[])),callbacks:xt(),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]&&(wn.push(e),En(),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 er=[];function tr(e,t){return{subscribe:nr(e,t).subscribe}}function nr(e,t=yt){let n;const r=new Set;function o(t){if(kt(e,t)&&(e=t,n)){const t=!er.length;for(const t of r)t[1](),er.push(t,e);if(t){for(let e=0;e{r.delete(l),0===r.size&&n&&(n(),n=null)}}}}function rr(e,{store:t,animate:n=!0,clickActive:r=!0,enabled:o=!0}={}){e.dataset.closing="false";const s=e.querySelector("summary");let i,a=null;for(const t of e.children)if("SUMMARY"!==t.tagName){a=t;break}let l,c=e.open;function u(t,r,o){const s=Math.max(0,30*Math.log(Math.abs(r-t)+Number.EPSILON));n?(e.style.overflow="hidden",a&&(a.style.overflow="hidden"),i=e.animate({height:[`${t}px`,`${r}px`]},{duration:s,easing:"ease-out"}),i.onfinish=()=>{e.open=o,e.dataset.closing="false",e.style.overflow=null,a&&(a.style.overflow=null)}):(e.open=o,e.dataset.closing="false",e.style.overflow=null,a&&(a.style.overflow=null))}it(t)||(t=nr(!1)),t&&(l=lt(t,(t=>{console.log(`!!! toggleDetails - 1st store callback - enabled: ${o}; typeof value: ${typeof t} `),o&&"boolean"==typeof t&&(c=t,e.open=c)}),(async e=>{console.log(`!!! toggleDetails - 2nd store callback - enabled: ${o}; typeof value: ${typeof e} `),o&&"boolean"==typeof e&&(c=e,await Cn(),d())})));const f=()=>{};function d(){if(n)if(c){const t=e.offsetHeight;i&&(i.cancel(),i.effect=null,i.onfinish=f),e.open=!0;u(t,e.offsetHeight,!0)}else{const t=e.offsetHeight;i&&(i.cancel(),i.effect=null,i.onfinish=f);const n=s.offsetHeight;e.dataset.closing="true",u(t,n,!1)}else e.open=c}function h(e){r&&o&&(e.preventDefault(),t.set(!c))}return s.addEventListener("click",h),{update(s){"boolean"==typeof s.animate&&(n=s.animate),"boolean"==typeof s.clickActive&&(r=s.clickActive),"boolean"==typeof s.enabled&&(o=s.enabled),it(s.store)&&s.store!==t&&("function"==typeof l&&l(),t=s.store,l=lt(t,(t=>{o&&"boolean"==typeof t&&(c=t,e.open=c)}),(async e=>{o&&"boolean"==typeof e&&(c=e,await Cn(),d())})))},destroy(){"function"==typeof l&&l(),s.removeEventListener("click",h)}}}function or({storage:e,serialize:t=JSON.stringify,deserialize:n=JSON.parse}){function r(e,t,n){return{subscribe:o(e,t,n).subscribe}}function o(r,o,s){if(e){const s=e.getItem(r);try{s&&(o=n(s))}catch(e){}e.setItem(r,t(o))}const i=nr(o,s?function(n){return s((function(o){return e&&e.setItem(r,t(o)),n(o)}),(function(e){a(e(It(i)))}))}:void 0);function a(n){e&&e.setItem(r,t(n)),i.set(n)}return{set:a,update:function(e){a(e(It(i)))},subscribe:function(e,t){return i.subscribe(e,t)}}}return{readable:r,writable:o,derived:function(t,o,s,i){const a=!Array.isArray(o),l=a?[o]:o;if(e&&e.getItem(t))try{i=n(e.getItem(t))}catch(e){}return r(t,i,((e,t)=>{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 sr=or({storage:globalThis?.localStorage}),ir=or({storage:globalThis?.sessionStorage});class ar{#a;#l=new Map;constructor(e){this.#a=e}#c(e,t=void 0,n){try{const r=this.#a.storage.getItem(e);if(null!==r){t=(n?.deserialize??this.#a.deserialize)(r)}}catch(e){}return(n?.writable??this.#a.writable)(e,t)}#u(e){return this.#l.get(e)?.deserialize??this.#a.deserialize}#f(e){return this.#l.get(e)?.serialize??this.#a.serialize}#d(e,t=void 0,n){const r=this.#l.get(e);if(r)return r.store;const o=this.#c(e,t,n);return this.#l.set(e,{store:o,deserialize:n?.deserialize,serialize:n?.serialize}),o}getItem(e,t){let n=t;const r=this.#a.storage.getItem(e);if(null!==r)try{n=this.#u(e)(r)}catch(e){n=t}else if(void 0!==t)try{const n=this.#f(e)(t);this.#a.storage.setItem(e,n)}catch(e){}return n}getStore(e,t,n){return this.#d(e,t,n)}hasStore(e){return this.#l.has(e)}setItem(e,t){this.#d(e).set(t)}swapItemBoolean(e,t){const n=this.#d(e,t);let r=!1;try{r=!!this.#u(e)(this.#a.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.#l.size)if(e)for(const t of this.#l.keys())e.test(t)&&(yield[t,this.getStore(t)]);else for(const e of this.#l.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.#l.size)if(e)for(const t of this.#l.keys())e.test(t)&&(yield t);else for(const e of this.#l.keys())yield e}*stores(e=void 0){if(void 0!==e&&!(e instanceof RegExp))throw new TypeError("'regex' is not a RegExp");if(this.#l.size)if(e)for(const t of this.#l.keys())e.test(t)&&(yield this.getStore(t));else for(const e of this.#l.keys())yield this.getStore(e)}}class lr extends ar{constructor(){super(sr)}}class cr extends ar{constructor(){super(ir)}}class ur{static#h=[];static#p=new cr;static#g;static get sessionStorage(){return this.#p}static initialize(e){globalThis.requestAnimationFrame((()=>{this.#m(e.storagePrepend),e.settingStores.themeAnimate.subscribe((e=>this.#y(e)))}))}static openOnThisPage({focus:e=!0}={}){const t=globalThis.document.querySelector("details.tsd-page-navigation");if(t){const n=t.querySelector("summary");n&&(this.#p.hasStore(this.#g)&&this.#p.getStore(this.#g).set(!0),e&&setTimeout((()=>n.focus({focusVisible:!0})),0))}}static#m(e){const t=document.querySelectorAll("details.tsd-accordion"),n=new Map;for(const r of t){const t=r.querySelector("summary");let o;t&&(o=`${e}-accordion-${t.dataset.key??t.textContent?.trim?.()?.replace(/\s+/g,"-").toLowerCase()}`),o===`${e}-accordion-on-this-page`&&(this.#g=o),"string"==typeof o&&o.length&&n.set(o,r)}const r=new RegExp(`${e}-accordion-(?section-|tsd-otp-)(?.*)`),o=new Map;for(const[t,s]of n){const n=r.exec(t);if(n){const t=`${e}-accordion-section-otp-${n.groups.key}`,r=o.get(t)??new Set;r.add(s),o.set(t,r)}else{const e=this.#p.getStore(t,s.open);this.#h.push(rr(s,{store:e})),s.addEventListener("toggle",(t=>e.set(t.target.open)))}}const s=globalThis.location.hash;for(const[e,t]of o){const n=this.#p.getStore(e,!0);if(s)for(const e of t){Array.from(e.querySelectorAll("*")).find((e=>`#${e.id}`===s))&&n.set(!0)}for(const e of t)this.#h.push(rr(e,{store:n})),e.addEventListener("toggle",(e=>n.set(e.target.open)))}setTimeout((()=>{for(const e of n.values()){const t=e.querySelector("summary svg");t&&t.classList.add("dmt-summary-svg")}}),500)}static#y(e){for(const t of this.#h)t?.update({animate:e})}}class fr{static#b=new Set(["KeyboardEvent","MouseEvent","PointerEvent"]);static#v=new Set(["MouseEvent","PointerEvent"]);static#w=!1;static get debug(){return this.#w}static set debug(e){if("boolean"!=typeof e)throw new TypeError("'debug' is not a boolean.");this.#w=e}static get prefersReducedMotion(){return globalThis?.matchMedia("(prefers-reduced-motion: reduce)")?.matches??!1}static applyFocusSource(e){if(!ut(e))return;const t=ut(e?.focusSource)?e.focusSource:e;setTimeout((()=>{const e="boolean"==typeof t.debug?this.debug||t.debug:this.debug;if(ct(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&&!ct(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.#x(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#x(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(!fr.#b.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&&(fr.isFocusable(e.target)?(i=e.target,s&&console.debug("A11yHelper.getFocusSource debug: 'targetEl' set to event.target: ",i)):fr.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(fr.#v.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&&!ct(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 dr(e=1){if(!Number.isInteger(e)||e<1)throw new TypeError("nextAnimationFrame error: 'cntr' must be a positive integer greater than 0.");let t;for(;--e>=0;)t=await new Promise((e=>requestAnimationFrame(e)));return t}let hr=class{static searchPath(e,t,n){if(!e?.length)return!1;for(const n of e)if(!Array.isArray(n.children)&&n?.path===t)return!0;for(const r of e)if(Array.isArray(r.children)&&this.#S(r,t,n))return!0;return!1}static walk(e,t){for(const n of e)Array.isArray(n.children)&&this.#$(n,void 0,t)}static walkFrom(e,t){this.#$(e,void 0,t)}static#S(e,t,n){if(e.path===t)return!0;if(Array.isArray(e.children))for(const r of e.children){if(this.#S(r,t,n))return n({entry:e}),!0}return!1}static#$(e,t,n){if(Array.isArray(e.children))for(const t of e.children)this.#$(t,e,n);n({entry:e,parentEntry:t})}};class pr{#k;#T=!1;#E;#C;#I;#L;#P;constructor({currentPathURL:e,setCurrentPathURL:t,elementIndex:n,storagePrepend:r,treeName:o}){this.#C=t,this.#k=n,this.#I=r,this.#P=o,this.#E=new cr,this.#O(e),this.#A()}get elementIndex(){return this.#k}get hasData(){return this.#k?.length>0}get hasFolders(){return this.#T}get sessionStorage(){return this.#E}get storeFoldersAllOpen(){return this.#L}ensureCurrentPath(e,{setCurrent:t=!0}={}){const n=hr.searchPath(this.elementIndex,e,(({entry:e})=>{e.storageKey&&this.#E.setItem(e.storageKey,!0)}));return n&&t&&this.#C(e,this.#P),n}setChildFolderState(e,t){hr.walkFrom(e,(({entry:e})=>{e.storageKey&&this.#E.setItem(e.storageKey,t)}))}setFoldersAllOpen(e){for(const t of this.sessionStorage.stores())t.set(e)}swapFoldersAllOpen(){this.setFoldersAllOpen(!It(this.storeFoldersAllOpen))}#A(){this.#L=function(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 tr(n,((e,n)=>{let i=!1;const a=[];let l=0,c=yt;const u=()=>{if(l)return;c();const o=t(r?a[0]:a,e,n);s?e(o):c=$t(o)?o:yt},f=o.map(((e,t)=>Ct(e,(e=>{a[t]=e,l&=~(1<{l|=1<t(!!e.reduce(((e,t)=>e&t),!0))))}#M(e){return hr.searchPath(this.elementIndex,e,(({entry:e})=>{e.storageKey&&this.#E.setItem(e.storageKey,!0)}))}#D(){let e=0;hr.walk(this.#k,(({entry:t,parentEntry:n})=>{if(n||e++,!Array.isArray(t?.children))return;const r=n?n.path??n.text:"";t.storageKey=`${this.#I}-${t.path??`${r}-${t.text}`}`,this.#E.getStore(t.storageKey,!1)})),this.#T=e>0}#O(e){this.#D();const t=this.#M(e);if(t)this.#C(e,this.#P);else if(e.includes("#")){const n=e.split("#");if(!t){const e=n[0];e&&this.#M(e)&&this.#C(e,this.#P)}}}}class gr{#R="";#F;#N;#U;#j;#B;#_;constructor(e,t,n){this.#N=e,this.#F=t.initialPathURL;const{subscribe:r,update:o}=nr(this.#F);this.#U=Object.freeze({subscribe:r}),this.#j=o;const s=t.storagePrepend,i=this.#C.bind(this);this.#B=new pr({currentPathURL:this.#F,setCurrentPathURL:i,elementIndex:n?.markdown??[],storagePrepend:`${s}-markdown`,treeName:"markdown"}),this.#_=new pr({currentPathURL:this.#F,setCurrentPathURL:i,elementIndex:n?.source??[],storagePrepend:`${s}-source`,treeName:"source"}),this.#Q(),globalThis.addEventListener("hashchange",this.#z.bind(this))}get activeTreeName(){return this.#R}get currentPathURL(){return this.#F}get markdown(){return this.#B}get source(){return this.#_}get storeCurrentPathURL(){return this.#U}ensureCurrentPath({pathURL:e=this.#F,focus:t=!1}={}){let n=!1;n|=this.#B.ensureCurrentPath(e),n|=this.#_.ensureCurrentPath(e),n&&t&&dr().then((()=>document.querySelector("nav.tsd-navigation")?.querySelector(`a[href*="${e}"]`)?.focus({focusVisible:!0})))}#Q(){const e=this;function t(t){t.preventDefault();if(globalThis.location.href.split("#")[0]!==this.href.split("#")[0]||globalThis.location.hash!==this.hash)return void(globalThis.location.href=this.href);const n=this.href.replace(e.#N.baseURL,"");if(!e.ensureCurrentPath({pathURL:n})&&n.includes("#")){const t=n.split("#");t[0]&&e.ensureCurrentPath({pathURL:t[0]})}}const n=document.querySelectorAll('div.col-content a[href*="#"], details.tsd-page-navigation a[href*="#"]');for(const e of n)e.addEventListener("click",t)}#z(e){const t=e.newURL.replace(this.#N.baseURL,"");if(!this.ensureCurrentPath({pathURL:t})&&t.includes("#")){const e=t.split("#")[0];e&&this.ensureCurrentPath({pathURL:e})}}#C(e,t){switch(t){case"markdown":case"source":this.#R=t;break;default:this.#R=""}this.#F=e,this.#j((()=>e))}}class mr{#H;constructor(e,t){this.#H=new gr(this,e,t)}get treeState(){return this.#H}}var yr,br={exports:{}}; +import"./dmt-component-data.js";var e,t,n;try{e=new TextDecoder}catch(e){}var r,o,i,s,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 b{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,s){if(t)return W((()=>(J(),this?this.unpack(e,s):b.prototype.unpack.call(h,e,s))));e.buffer||e.constructor!==ArrayBuffer||(e="undefined"!=typeof Buffer?Buffer.from(e):new Uint8Array(e)),"object"==typeof s?(n=s.end||e.length,l=s.start||0):(l=0,n=s>-1?s:e.length),f=0,o=null,i=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 b){if(c=this,this.structures)return r=this.structures,v(s);(!r||r.length>0)&&(r=[])}else c=h,(!r||r.length>0)&&(r=[]);return v(s)}unpackMultiple(e,t){let n,r=0;try{m=!0;let o=e.length,i=this?this.unpack(e,o):G.unpack(e,o);if(!t){for(n=[i];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 v(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(),J(),(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&&T()[63&e];return t?(t.read||(t.read=E(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?N(t):D(t);if(null!=e)return e}return k(t)}{let n;switch(e){case 192:return null;case 193:return i?(n=x(),n>0?i[1].slice(i.position1,i.position1+=n):i[0].slice(i.position0,i.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 F(n);case 197:return n=a.getUint16(l),l+=2,F(n);case 198:return n=a.getUint32(l),l+=4,F(n);case 199:return U(t[l++]);case 200:return n=a.getUint16(l),l+=2,U(n);case 201:return n=a.getUint32(l),l+=4,U(n);case 202:if(n=a.getFloat32(l),c.useFloat32>2){let e=K[(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):C(n);case 218:return n=a.getUint16(l),f>=(l+=2)?o.slice(l-u,(l+=n)-u):O(n);case 219:return n=a.getUint32(l),f>=(l+=4)?o.slice(l-u,(l+=n)-u):I(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,A(n);case 223:return n=a.getUint32(l),l+=4,A(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 S=/^[a-zA-Z_$][a-zA-Z\d_$]*$/;function E(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()":S.test(e)?e+":r()":"["+JSON.stringify(e)+"]:r()")).join(",")+"})}")(x);return 0===e.highByte&&(e.read=$(t,e.read)),n()}let r={};for(let t=0,n=e.length;tfunction(){let o=t[l++];if(0===o)return n();let i=e<32?-(e+(o<<5)):e+(o<<5),s=r[i]||T()[i];if(!s)throw new Error("Record id is not defined for "+i);return s.read||(s.read=E(s,e)),s.read()};function T(){let e=W((()=>(t=null,c.getStructures())));return r=c._mergeStructures(e,r)}var k=L,C=L,O=L,I=L;function L(n){let r;if(n<16&&(r=N(n)))return r;if(n>64&&e)return e.decode(t.subarray(l,l+=n));const o=l+n,i=[];for(r="";l65535&&(n-=65536,i.push(n>>>10&1023|55296),n=56320|1023&n),i.push(n)}else i.push(e);else i.push(e);i.length>=4096&&(r+=M.apply(String,i),i.length=0)}return i.length>0&&(r+=M.apply(String,i)),r}function P(e){let t=new Array(e);for(let n=0;n0)return void(l=n);r[o]=e}return M.apply(String,r)}function N(e){if(e<4){if(e<2){if(0===e)return"";{let e=t[l++];return(128&e)>1?void(l-=1):M(e)}}{let n=t[l++],r=t[l++];if((128&n)>0||(128&r)>0)return void(l-=2);if(e<3)return M(n,r);let o=t[l++];return(128&o)>0?void(l-=3):M(n,r,o)}}{let n=t[l++],r=t[l++],o=t[l++],i=t[l++];if((128&n)>0||(128&r)>0||(128&o)>0||(128&i)>0)return void(l-=4);if(e<6){if(4===e)return M(n,r,o,i);{let e=t[l++];return(128&e)>0?void(l-=5):M(n,r,o,i,e)}}if(e<8){let s=t[l++],a=t[l++];if((128&s)>0||(128&a)>0)return void(l-=6);if(e<7)return M(n,r,o,i,s,a);let c=t[l++];return(128&c)>0?void(l-=7):M(n,r,o,i,s,a,c)}{let s=t[l++],a=t[l++],c=t[l++],u=t[l++];if((128&s)>0||(128&a)>0||(128&c)>0||(128&u)>0)return void(l-=8);if(e<10){if(8===e)return M(n,r,o,i,s,a,c,u);{let e=t[l++];return(128&e)>0?void(l-=9):M(n,r,o,i,s,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 M(n,r,o,i,s,a,c,u,f,d);let h=t[l++];return(128&h)>0?void(l-=11):M(n,r,o,i,s,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 M(n,r,o,i,s,a,c,u,f,d,h,p);{let e=t[l++];return(128&e)>0?void(l-=13):M(n,r,o,i,s,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 M(n,r,o,i,s,a,c,u,f,d,h,p,g,m);let y=t[l++];return(128&y)>0?void(l-=15):M(n,r,o,i,s,a,c,u,f,d,h,p,g,m,y)}}}}}function R(){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 L(e)}function F(e){return c.copyBuffers?Uint8Array.prototype.slice.call(t,l,l+=e):t.subarray(l,l+=e)}function U(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 j=new Array(4096);function _(){let e=t[l++];if(!(e>=160&&e<192))return l--,B(x());if(e-=160,f>=l)return o.slice(l-u,(l+=e)-u);if(!(0==f&&n<180))return k(e);let r,i=4095&(e<<5^(e>1?a.getUint16(l):e>0?t[l]:0)),s=j[i],c=l,d=l+e-3,h=0;if(s&&s.bytes==e){for(;c{let n=x().map(B),o=e;void 0!==t&&(e=e<32?-((t<<5)+e):(t<<5)+e,n.highByte=t);let i=r[e];return i&&(i.isShared||m)&&((r.restoreStructures||(r.restoreStructures=[]))[e]=i),r[e]=n,n.read=E(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],{cause:e[2]})},d[105]=e=>{if(!1===c.structuredClone)throw new Error("Structured clone extension is disabled");let n=a.getUint32(l-4);s||(s=new Map);let r,o=t[l];r=o>=144&&o<160||220==o||221==o?[]:{};let i={target:r};s.set(n,i);let u=x();return i.used?Object.assign(r,u):(i.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=s.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){if(16===t){let t=new ArrayBuffer(e.length-1);return new Uint8Array(t).set(e.subarray(1)),t}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,b=s,v=i,w=new Uint8Array(t.slice(0,n)),x=r,S=r.slice(0,r.length),E=c,$=m,T=e();return n=d,l=h,u=p,f=g,o=y,s=b,i=v,t=w,m=$,(r=x).splice(0,r.length,...S),c=E,a=new DataView(t.buffer,t.byteOffset,t.byteLength),T}function J(){t=null,s=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,i=q,(i=[R(),R()]).position0=0,i.position1=0,i.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 K=new Array(147);for(let e=0;e<256;e++)K[e]=+("1e"+Math.floor(45.15-.30103*e));var G=new b({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,ie=ne?4294967296:2144337920;let se,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:i,position:s}=n(4+o);i[s++]=199,i[s++]=o+1}else if(o+1<65536){var{target:i,position:s}=n(5+o);i[s++]=200,i[s++]=o+1>>8,i[s++]=o+1&255}else{var{target:i,position:s,targetView:a}=n(7+o);i[s++]=201,a.setUint32(s,o+1),s+=4}i[s++]=116,i[s++]=t,e.buffer||(e=new Uint8Array(e)),i.set(new Uint8Array(e.buffer,e.byteOffset,e.byteLength),s)}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:i}=t(n+5);r[o++]=198,i.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:i}=t(10);n[i++]=215,n[i++]=255,o.setUint32(i,4e6*e.getMilliseconds()+(r/1e3/4294967296|0)),o.setUint32(i+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:i}=t(15);n[i++]=199,n[i++]=12,n[i++]=255,o.setUint32(i,1e6*e.getMilliseconds()),o.setBigInt64(i+4,BigInt(Math.floor(r)))}}},{pack(e,t,n){if(this.setAsEmptyObject)return t(0),n({});let r=Array.from(e),{target:o,position:i}=t(this.moreTypes?3:0);this.moreTypes&&(o[i++]=212,o[i++]=115,o[i++]=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,e.cause])}},{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 be=new class extends b{constructor(e){let t,n,r,o;super(e),this.offset=0;let i=oe.prototype.utf8Write?function(e,t){return se.utf8Write(e,t,se.byteLength-t)}:!(!Y||!Y.encodeInto)&&function(e,t){return Y.encodeInto(e,se.subarray(t)).written},s=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,i){if(se||(se=new re(8192),le=se.dataView||(se.dataView=new DataView(se.buffer,0,8192)),ue=0),ce=se.length-10,ce-ue<2048?(se=new re(se.length),le=se.dataView||(se.dataView=new DataView(se.buffer,0,se.length)),ce=se.length-10,ue=0):ue=ue+7&2147483640,t=ue,i&xe&&(ue+=255&i),o=s.structuredClone?new Map:null,s.bundleStrings&&"string"!=typeof e?(fe=[],fe.size=1/0):fe=null,r=s.structures,r){r.uninitialized&&(r=s._mergeStructures(s.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,i=-1;for(;n&&r>0;){let o=e[--r].offset+t;on.position+t?i>=0&&(i+=6):(i>=0&&(le.setUint32(n.position+t,le.getUint32(n.position+t)+i),i=-1),n=n.previous,r++)}i>=0&&n&&le.setUint32(n.position+t,le.getUint32(n.position+t)+i),ue+=6*e.length,ue>ce&&$(ue),s.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,i=n.id;e.copyWithin(t+r,t,o),r-=6;let s=t+r;e[s++]=214,e[s++]=105,e[s++]=i>>24,e[s++]=i>>16&255,e[s++]=i>>8&255,e[s++]=255&i,o=t}return e}(se.subarray(t,ue),e);return o=null,a}return s.offset=ue,i&ve?(se.start=t,se.end=ue,se):se.subarray(t,ue)}catch(e){throw l=e,e}finally{if(r&&(y(),n&&s.saveStructures)){let n=r.sharedLength||0,o=se.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,s);if(!l)return!1===s.saveStructures(a,a.isCompatible)?s.pack(e,i):(s.lastNamedStructuresLength=n,se.length>1073741824&&(se=null),o)}se.length>1073741824&&(se=null),i&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?se[ue++]=144|t:t<65536?(se[ue++]=220,se[ue++]=t>>8,se[ue++]=255&t):(se[ue++]=221,le.setUint32(ue,t),ue+=4);for(let n=0;n{ue>ce&&(se=$(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&&(se=$(ue+r)),fe.position?(n=fe,se[ue]=200,ue+=3,se[ue++]=98,e=ue-t,ue+=4,ye(t,v,0),le.setUint16(e+t-3,ue-t-e)):(se[ue++]=214,se[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,se[ue++]=193,void v(n?-o:o)}r=o<32?1:o<256?2:o<65536?3:5;let s=3*o;if(ue+s>ce&&(se=$(ue+s)),o<64||!i){let t,i,s,a=ue+r;for(t=0;t>6|192,se[a++]=63&i|128):55296==(64512&i)&&56320==(64512&(s=e.charCodeAt(t+1)))?(i=65536+((1023&i)<<10)+(1023&s),t++,se[a++]=i>>18|240,se[a++]=i>>12&63|128,se[a++]=i>>6&63|128,se[a++]=63&i|128):(se[a++]=i>>12|224,se[a++]=i>>6&63|128,se[a++]=63&i|128);n=a-ue-r}else n=i(e,ue+r);n<32?se[ue++]=160|n:n<256?(r<2&&se.copyWithin(ue+2,ue+1,ue+1+n),se[ue++]=217,se[ue++]=n):n<65536?(r<3&&se.copyWithin(ue+3,ue+2,ue+2+n),se[ue++]=218,se[ue++]=n>>8,se[ue++]=255&n):(r<5&&se.copyWithin(ue+5,ue+3,ue+3+n),se[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?se[ue++]=e:e<256?(se[ue++]=204,se[ue++]=e):e<65536?(se[ue++]=205,se[ue++]=e>>8,se[ue++]=255&e):(se[ue++]=206,le.setUint32(ue,e),ue+=4);else if((e|0)===e)e>=-32?se[ue++]=256+e:e>=-128?(se[ue++]=208,se[ue++]=e+256):e>=-32768?(se[ue++]=209,le.setInt16(ue,e),ue+=2):(se[ue++]=210,le.setInt32(ue,e),ue+=4);else{let t;if((t=this.useFloat32)>0&&e<4294967296&&e>=-2147483648){let n;if(se[ue++]=202,le.setFloat32(ue,e),t<4||((n=e*K[(127&se[ue])<<1|se[ue+1]>>7])|0)===n)return void(ue+=4);ue--}se[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 se[ue++]=214,se[ue++]=112,le.setUint32(ue,n.id),void(ue+=4)}o.set(e,{offset:ue-t})}let i=e.constructor;if(i===Object)E(e);else if(i===Array)b(e);else if(i===Map)if(this.mapAsEmptyObject)se[ue++]=128;else{(n=e.size)<16?se[ue++]=128|n:n<65536?(se[ue++]=222,se[ue++]=n>>8,se[ue++]=255&n):(se[ue++]=223,le.setUint32(ue,n),ue+=4);for(let[t,n]of e)v(t),v(n)}else{for(let t=0,n=X.length;t(se=o,o=null,ue+=e,ue>ce&&$(ue),{target:se,targetView:le,position:ue-e})),v)}finally{o&&(se=o,le=i,ue=s,ce=se.length-10)}return void(r&&(r.length+ue>ce&&$(r.length+ue),ue=me(r,se,ue,n.type)))}}if(Array.isArray(e))b(e);else{if(e.toJSON){const t=e.toJSON();if(t!==e)return v(t)}if("function"===r)return v(this.writeFunction&&this.writeFunction(e));E(e)}}}else se[ue++]=192;else if("boolean"===r)se[ue++]=e?195:194;else if("bigint"===r){if(e=-(BigInt(1)<0)se[ue++]=207,le.setBigUint64(ue,e);else{if(!this.largeBigIntToFloat){if(this.largeBigIntToString)return v(e.toString());if(this.useBigIntExtension&&e-(BigInt(2)**BigInt(1023))){se[ue++]=199,ue++,se[ue++]=66;let t,n=[];do{let r=e&BigInt(255);t=(r&BigInt(128))===(e>=BigInt(8)}while(e!==BigInt(0)&&e!==BigInt(-1)||!t);se[ue-2]=n.length;for(let e=n.length;e>0;)se[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, or set largeBigIntToString to convert to string")}se[ue++]=203,le.setFloat64(ue,Number(e))}ue+=8}else{if("undefined"!==r)throw new Error("Unknown type: "+r);this.encodeUndefinedAsNil?se[ue++]=192:(se[ue++]=212,se[ue++]=0,se[ue++]=0)}},w=this.variableMapSize||this.coercibleKeyAsNumber||this.skipValues?e=>{let t;if(this.skipValues){t=[];for(let n in e)"function"==typeof e.hasOwnProperty&&!e.hasOwnProperty(n)||this.skipValues.includes(e[n])||t.push(n)}else t=Object.keys(e);let n,r=t.length;if(r<16?se[ue++]=128|r:r<65536?(se[ue++]=222,se[ue++]=r>>8,se[ue++]=255&r):(se[ue++]=223,le.setUint32(ue,r),ue+=4),this.coercibleKeyAsNumber)for(let o=0;o{se[ue++]=222;let n=ue-t;ue+=2;let r=0;for(let t in e)("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(t))&&(v(t),v(e[t]),r++);if(r>65535)throw new Error('Object is too large to serialize with fast 16-bit map size, use the "variableMapSize" option to serialize this object');se[n+++t]=r>>8,se[n+t]=255&r},x=!1===this.useRecords?w:e.progressiveRecords&&!f?e=>{let n,o,i=r.transitions||(r.transitions=Object.create(null)),s=ue++-t;for(let a in e)if("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(a)){if(n=i[a],n)i=n;else{let l=Object.keys(e),c=i;i=r.transitions;let u=0;for(let e=0,t=l.length;e{let t,n=r.transitions||(r.transitions=Object.create(null)),o=0;for(let r in e)("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(r))&&(t=n[r],t||(t=n[r]=Object.create(null),o++),n=t);let i=n[he];i?i>=96&&f?(se[ue++]=96+(31&(i-=96)),se[ue++]=i>>5):se[ue++]=i:T(n,n.__keys__||Object.keys(e),o);for(let t in e)("function"!=typeof e.hasOwnProperty||e.hasOwnProperty(t))&&v(e[t])},S="function"==typeof this.useRecords&&this.useRecords,E=S?e=>{S(e)?x(e):w(e)}:x,$=e=>{let n;if(e>16777216){if(e-t>ie)throw new Error("Packed buffer would be larger than maximum buffer size");n=Math.min(ie,4096*Math.round(Math.max((e-t)*(e>67108864?1.25:2),4194304)/4096))}else n=1+(Math.max(e-t<<2,se.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,se.length),se.copy?se.copy(r,0,t,e):r.set(se.slice(t,e)),ue-=t,t=0,ce=r.length-10,se=r},T=(e,t,o)=>{let i=r.nextId;i||(i=64),i=h&&(i=d),r.nextId=i+1);let s=t.highByte=i>=96&&f?i-96>>5:-1;e[he]=i,e.__keys__=t,r[i-64]=t,i=0?(se[ue++]=96+(31&i),se[ue++]=s):se[ue++]=i):(s>=0?(se[ue++]=213,se[ue++]=114,se[ue++]=96+(31&i),se[ue++]=s):(se[ue++]=212,se[ue++]=114,se[ue++]=i),o&&(g+=m*o),p.length>=u&&(p.shift()[he]=0),p.push(e),v(t))},k=(e,n,r,o)=>{let i=se,s=ue,a=ce,l=t;se=ae,ue=0,t=0,se||(ae=se=new re(8192)),ce=se.length-10,T(e,n,o),ae=se;let c=ue;if(se=i,ue=s,ce=a,t=l,c>1){let e=ue+c-1;e>ce&&$(e);let n=r+t;se.copyWithin(n+c,n+1,ue),se.set(ae.slice(0,c),n),ue=e}else se[r+t]=ae[0]},C=e=>{let o=undefined(e,se,t,ue,r,$,((e,t,r)=>{if(r)return n=!0;ue=t;let o=se;return v(e),y(),o!==se?{position:ue,targetView:le,target:se}:ue}),this);if(0===o)return E(e);ue=o}}useBuffer(e){se=e,se.dataView||(se.dataView=new DataView(se.buffer,se.byteOffset,se.byteLength)),ue=0}set position(e){ue=e}get position(){return ue}clearSharedData(){this.structures&&(this.structures=[]),this.typedStructs&&(this.typedStructs=[])}}({useRecords:!1});be.pack,be.pack;const ve=512,we=1024,xe=2048;var Se=Uint8Array,Ee=Uint16Array,$e=Int32Array,Te=new Se([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]),ke=new Se([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]),Ce=new Se([16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15]),Oe=function(e,t){for(var n=new Ee(31),r=0;r<31;++r)n[r]=t+=1<>1|(21845&De)<<1;Ne=(61680&(Ne=(52428&Ne)>>2|(13107&Ne)<<2))>>4|(3855&Ne)<<4,Me[De]=((65280&Ne)>>8|(255&Ne)<<8)>>1}var Re=function(e,t,n){for(var r=e.length,o=0,i=new Ee(t);o>l]=c}else for(s=new Ee(r),o=0;o>15-e[o]);return s},Fe=new Se(288);for(De=0;De<144;++De)Fe[De]=8;for(De=144;De<256;++De)Fe[De]=9;for(De=256;De<280;++De)Fe[De]=7;for(De=280;De<288;++De)Fe[De]=8;var Ue=new Se(32);for(De=0;De<32;++De)Ue[De]=5;var je=Re(Fe,9,1),_e=Re(Ue,5,1),Be=function(e){for(var t=e[0],n=1;nt&&(t=e[n]);return t},Qe=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,i=r?r.length:0;if(!o||t.f&&!t.l)return n||new Se(0);var s=!n,a=s||2!=t.i,l=t.i;s&&(n=new Se(3*o));var c=function(e){var t=n.length;if(e>t){var r=new Se(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=Qe(e,f,1);var b=Qe(e,f+1,3);if(f+=3,!b){var v=e[(L=4+((f+7)/8|0))-4]|e[L-3]<<8,w=L+v;if(w>o){l&&Ve(0);break}a&&c(d+v),n.set(e.subarray(L,w),d),t.b=d+=v,t.p=f=8*w,t.f=u;continue}if(1==b)h=je,p=_e,g=9,m=5;else if(2==b){var x=Qe(e,f,31)+257,S=Qe(e,f+10,15)+4,E=x+Qe(e,f+5,31)+1;f+=14;for(var $=new Se(E),T=new Se(19),k=0;k>4)<16)$[k++]=L;else{var A=0,M=0;for(16==L?(M=3+Qe(e,f,3),f+=2,A=$[k-1]):17==L?(M=3+Qe(e,f,7),f+=3):18==L&&(M=11+Qe(e,f,127),f+=7);M--;)$[k++]=A}}var D=$.subarray(0,x),N=$.subarray(x);g=Be(D),m=Be(N),h=Re(D,g,1),p=Re(N,m,1)}else Ve(1);if(f>y){l&&Ve(0);break}}a&&c(d+131072);for(var R=(1<>4;if((f+=15&A)>y){l&&Ve(0);break}if(A||Ve(2),j<256)n[d++]=j;else{if(256==j){U=f,h=null;break}var _=j-254;if(j>264){var B=Te[k=j-257];_=Qe(e,f,(1<>4;Q||Ve(3),f+=15&Q;N=Ae[z];if(z>3){B=ke[z];N+=ze(e,f)&(1<y){l&&Ve(0);break}a&&c(d+131072);var H=d+_;if(de.length)&&(n=e.length),new Se(e.subarray(t,n))}(n,0,d):n.subarray(0,d)},We=new Se(0);function Je(e,t){return qe(e,{i:2},t&&t.out,t&&t.dictionary)}var Ke="undefined"!=typeof TextDecoder&&new TextDecoder;try{Ke.decode(We,{stream:!0})}catch(e){}const Ge="function"==typeof Buffer;"function"==typeof TextDecoder&&new TextDecoder,"function"==typeof TextEncoder&&new TextEncoder;const Ze=Array.prototype.slice.call("ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/="),Ye=(()=>{let e={};return Ze.forEach(((t,n)=>e[t]=n)),e})(),Xe=/^(?:[A-Za-z\d+\/]{4})*?(?:[A-Za-z\d+\/]{2}(?:==)?|[A-Za-z\d+\/]{3}=?)?$/,et=String.fromCharCode.bind(String),tt="function"==typeof Uint8Array.from?Uint8Array.from.bind(Uint8Array):e=>new Uint8Array(Array.prototype.slice.call(e,0)),nt=e=>e.replace(/[^A-Za-z0-9\+\/]/g,""),rt="function"==typeof atob?e=>atob(nt(e)):Ge?e=>Buffer.from(e,"base64").toString("binary"):e=>{if(e=e.replace(/\s+/g,""),!Xe.test(e))throw new TypeError("malformed base64.");e+="==".slice(2-(3&e.length));let t,n,r,o="";for(let i=0;i>16&255):64===r?et(t>>16&255,t>>8&255):et(t>>16&255,t>>8&255,255&t);return o},ot=Ge?e=>tt(Buffer.from(e,"base64")):e=>tt(rt(e).split("").map((e=>e.charCodeAt(0)))),it=e=>nt(e.replace(/[-_]/g,(e=>"-"==e?"+":"/")));function st(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 at(e){if(null==e)return!1;switch(typeof e){case"function":case"object":return"function"==typeof e.subscribe&&"function"==typeof e.set&&"function"==typeof e.update}return!1}function lt(e,t,n){let r=!1;return e.subscribe((e=>{r?n(e):(r=!0,t(e))}))}function ct(e){return null!=e&&"object"==typeof e&&Symbol.iterator in e}function ut(e){return null!==e&&"object"==typeof e&&!Array.isArray(e)}function ft(e,t,n){if("object"!=typeof e)return n;if("string"!=typeof t)return n;const r=t.split(".");for(let t=0;t=0;)if(this.#s(e,Node.ELEMENT_NODE,this.#e[t]))return!0;return!1}static isDocumentFragment(e){return this.#s(e,Node.DOCUMENT_FRAGMENT_NODE,"DocumentFragment")}static isElement(e){return this.#s(e,Node.ELEMENT_NODE,"Element")}static isHTMLAnchorElement(e){return this.#s(e,Node.ELEMENT_NODE,"HTMLAnchorElement")}static isHTMLElement(e){return this.#s(e,Node.ELEMENT_NODE,"HTMLElement")}static isNode(e){if("number"!=typeof e?.nodeType)return!1;if(e instanceof globalThis.Node)return!0;const t=this.getWindow(e,this.#i),n=t?.Node;return n&&e instanceof n}static isShadowRoot(e){return this.#s(e,Node.DOCUMENT_FRAGMENT_NODE,"ShadowRoot")}static isSVGElement(e){return this.#s(e,Node.ELEMENT_NODE,"SVGElement")}static isEvent(e,t){return"string"==typeof e?.type&&"boolean"==typeof e?.defaultPrevented&&"function"==typeof e?.stopPropagation&&(void 0===t||this.isCtorName(e,t))}static isPointerEvent(e){return this.isEvent(e,this.#n)}static isUIEvent(e){return this.isEvent(e,this.#r)}static isUserInputEvent(e){return this.isEvent(e,this.#o)}static isCtorName(e,t){return!!ut(e)&&("string"==typeof t&&e?.constructor?.name===t||!!t?.has(e?.constructor?.name))}static#s(e,t,n){if(!ut(e))return!1;if(e.nodeType!==t)return!1;const r=globalThis[n];if(r&&e instanceof r)return!0;const o=this.#t.has(e.nodeType)?e?.ownerDocument?.defaultView:this.getWindow(e,this.#i),i=o?.[n];return i&&e instanceof i}}class ht{static#a=/(\d+)\s*px/;static pixels(e){if("string"!=typeof e)return;const t=this.#a.test(e),n=parseInt(e);return t&&Number.isFinite(n)?n:void 0}static remPixels(e=1,{targetDocument:t=document}={}){return t?.documentElement?e*parseFloat(globalThis.getComputedStyle(t.documentElement).fontSize):void 0}}class pt{#l=new Map;#c;static#u=Object.freeze({none:0,attribute:1,function:2,resizeObserved:3,setContentBounds:4,setDimension:5,storeObject:6,storesObject:7});constructor(){this.#c=new ResizeObserver((e=>{for(const t of e){const e=this.#l.get(t?.target);if(Array.isArray(e)){const n=t.contentRect.width,r=t.contentRect.height;for(const t of e)pt.#f(t,n,r)}}}))}add(e,t){if(!dt.isHTMLElement(e))throw new TypeError("ResizeObserverManager.add error: 'el' is not a HTMLElement.");if(this.#d(e,t))return;const n=pt.#h(t);if(0===n)throw new Error("ResizeObserverManager.add error: 'target' is not a valid ResizeObserverManager target.");const r=globalThis.getComputedStyle(e),o=ht.pixels(e.style.borderBottom)??ht.pixels(r.borderBottom)??0,i=ht.pixels(e.style.borderLeft)??ht.pixels(r.borderLeft)??0,s=ht.pixels(e.style.borderRight)??ht.pixels(r.borderRight)??0,a=ht.pixels(e.style.borderTop)??ht.pixels(r.borderTop)??0,l=ht.pixels(e.style.paddingBottom)??ht.pixels(r.paddingBottom)??0,c={updateType:n,target:t,contentWidth:0,contentHeight:0,styles:{additionalWidth:i+s+(ht.pixels(e.style.paddingLeft)??ht.pixels(r.paddingLeft)??0)+(ht.pixels(e.style.paddingRight)??ht.pixels(r.paddingRight)??0),additionalHeight:a+o+(ht.pixels(e.style.paddingTop)??ht.pixels(r.paddingTop)??0)+l}};if(this.#l.has(e)){this.#l.get(e).push(c)}else this.#l.set(e,[c]);this.#c.observe(e)}clear(){for(const e of this.#l.keys())this.#c.unobserve(e);this.#l.clear()}remove(e,t=void 0){const n=this.#l.get(e);if(Array.isArray(n)){if(void 0!==t){const e=n.findIndex((e=>e.target===t));e>=0&&n.splice(e,1)}else n.length=0;0===n.length&&(this.#l.delete(e),this.#c.unobserve(e))}}updateCache(e){const t=this.#l.get(e);if(Array.isArray(t)){const n=globalThis.getComputedStyle(e),r=ht.pixels(e.style.borderBottom)??ht.pixels(n.borderBottom)??0,o=ht.pixels(e.style.borderLeft)??ht.pixels(n.borderLeft)??0,i=ht.pixels(e.style.borderRight)??ht.pixels(n.borderRight)??0,s=ht.pixels(e.style.borderTop)??ht.pixels(n.borderTop)??0,a=ht.pixels(e.style.paddingBottom)??ht.pixels(n.paddingBottom)??0,l=o+i+(ht.pixels(e.style.paddingLeft)??ht.pixels(n.paddingLeft)??0)+(ht.pixels(e.style.paddingRight)??ht.pixels(n.paddingRight)??0),c=s+r+(ht.pixels(e.style.paddingTop)??ht.pixels(n.paddingTop)??0)+a;for(const e of t)e.styles.additionalWidth=l,e.styles.additionalHeight=c,pt.#f(e,e.contentWidth,e.contentHeight)}}static#h(e){if("function"==typeof e?.resizeObserved)return this.#u.resizeObserved;if("function"==typeof e?.setDimension)return this.#u.setDimension;if("function"==typeof e?.setContentBounds)return this.#u.setContentBounds;const t=typeof e;if(null!==t&&("object"===t||"function"===t)){if(at(e.resizeObserved))return this.#u.storeObject;const t=e?.stores;if((ut(t)||"function"==typeof t)&&at(t.resizeObserved))return this.#u.storesObject}return null!==t&&"object"===t?this.#u.attribute:"function"===t?this.#u.function:this.#u.none}#d(e,t){if(null==t)return!1;const n=this.#l.get(e);return!!Array.isArray(n)&&n.findIndex((e=>e.target===t))>=0}static#f(e,t,n){const r=e.styles;e.contentWidth=t,e.contentHeight=n;const o=Number.isFinite(t)?t+r.additionalWidth:void 0,i=Number.isFinite(n)?n+r.additionalHeight:void 0,s=e.target;switch(e.updateType){case this.#u.attribute:s.contentWidth=t,s.contentHeight=n,s.offsetWidth=o,s.offsetHeight=i;break;case this.#u.function:s?.(o,i,t,n);break;case this.#u.resizeObserved:s.resizeObserved?.(o,i,t,n);break;case this.#u.setContentBounds:s.setContentBounds?.(t,n);break;case this.#u.setDimension:s.setDimension?.(o,i);break;case this.#u.storeObject:s.resizeObserved.update((e=>(e.contentHeight=n,e.contentWidth=t,e.offsetHeight=i,e.offsetWidth=o,e)));break;case this.#u.storesObject:s.stores.resizeObserved.update((e=>(e.contentHeight=n,e.contentWidth=t,e.offsetHeight=i,e.offsetWidth=o,e)))}}}const gt=new pt;function mt(e,t){return gt.add(e,t),{update:n=>{gt.remove(e,t),t=n,gt.add(e,t)},destroy:()=>{gt.remove(e,t)}}}mt.updateCache=function(e){gt.updateCache(e)};class yt{constructor(){throw new Error("Timing constructor: This is a static class and should not be constructed.")}static debounce(e,t){if("function"!=typeof e)throw new TypeError("'callback' must be a function.");if(!Number.isInteger(t)||t<0)throw new TypeError("'delay' must be a positive integer representing milliseconds.");let n;return function(...r){globalThis.clearTimeout(n),n=globalThis.setTimeout((()=>{e.apply(this,r)}),t)}}static doubleClick({single:e,double:t,delay:n=400}){if(void 0!==e&&"function"!=typeof e)throw new TypeError("'single' must be a function.");if(void 0!==t&&"function"!=typeof t)throw new TypeError("'double' must be a function.");if(!Number.isInteger(n)||n<0)throw new TypeError("'delay' must be a positive integer representing milliseconds.");let r,o=0;return i=>{globalThis.clearTimeout(r),o++,1===o?r=globalThis.setTimeout((()=>{"function"==typeof e&&e(i),o=0}),n):("function"==typeof t&&t(i),o=0)}}}function bt(){}const vt=e=>e;function wt(e,t){for(const n in t)e[n]=t[n];return e}function xt(e){return e()}function St(){return Object.create(null)}function Et(e){e.forEach(xt)}function $t(e){return"function"==typeof e}function Tt(e,t){return e!=e?t==t:e!==t||e&&"object"==typeof e||"function"==typeof e}let kt;function Ct(e,t){return e===t||(kt||(kt=document.createElement("a")),kt.href=t,e===kt.href)}function Ot(e,...t){if(null==e){for(const e of t)e(void 0);return bt}const n=e.subscribe(...t);return n.unsubscribe?()=>n.unsubscribe():n}function It(e){let t;return Ot(e,(e=>t=e))(),t}function Lt(e,t,n){e.$$.on_destroy.push(Ot(t,n))}function Pt(e,t,n,r){if(e){const o=At(e,t,n,r);return e[0](o)}}function At(e,t,n,r){return e[1]&&r?wt(n.ctx.slice(),e[1](r(t))):n.ctx}function Mt(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(),Bt=jt?e=>requestAnimationFrame(e):bt;const Qt=new Set;function zt(e){Qt.forEach((t=>{t.c(e)||(Qt.delete(t),t.f())})),0!==Qt.size&&Bt(zt)}const Ht="undefined"!=typeof window?window:"undefined"!=typeof globalThis?globalThis:global;function Vt(e,t){e.appendChild(t)}function qt(e){if(!e)return document;const t=e.getRootNode?e.getRootNode():e.ownerDocument;return t&&t.host?t:e.ownerDocument}function Wt(e){const t=Gt("style");return t.textContent="/* empty */",function(e,t){Vt(e.head||e,t),t.sheet}(qt(e),t),t.sheet}function Jt(e,t,n){e.insertBefore(t,n||null)}function Kt(e){e.parentNode&&e.parentNode.removeChild(e)}function Gt(e){return document.createElement(e)}function Zt(e){return document.createElementNS("http://www.w3.org/2000/svg",e)}function Yt(e){return document.createTextNode(e)}function Xt(){return Yt(" ")}function en(){return Yt("")}function tn(e,t,n,r){return e.addEventListener(t,n,r),()=>e.removeEventListener(t,n,r)}function nn(e){return function(t){return t.stopPropagation(),e.call(this,t)}}function rn(e,t,n){null==n?e.removeAttribute(t):e.getAttribute(t)!==n&&e.setAttribute(t,n)}function on(e,t){t=""+t,e.data!==t&&(e.data=t)}function sn(e,t){e.value=null==t?"":t}function an(e,t,n,r){null==n?e.style.removeProperty(t):e.style.setProperty(t,n,"")}function ln(e,t,n){e.classList.toggle(t,!!n)}function cn(e,t){return new e(t)}const un=new Map;let fn,dn=0;function hn(e,t,n,r,o,i,s,a=0){const l=16.666/r;let c="{\n";for(let e=0;e<=1;e+=l){const r=t+(n-t)*i(e);c+=100*e+`%{${s(r,1-r)}}\n`}const u=c+`100% {${s(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=qt(e),{stylesheet:h,rules:p}=un.get(d)||function(e,t){const n={stylesheet:Wt(t),rules:{}};return un.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`,dn+=1,f}function pn(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(", "),dn-=o,dn||Bt((()=>{dn||(un.forEach((e=>{const{ownerNode:t}=e.stylesheet;t&&Kt(t)})),un.clear())})))}function gn(e){fn=e}function mn(){if(!fn)throw new Error("Function called outside component initialization");return fn}function yn(e){mn().$$.on_mount.push(e)}function bn(e,t){return mn().$$.context.set(e,t),t}function vn(e){return mn().$$.context.get(e)}function wn(e,t){const n=e.$$.callbacks[t.type];n&&n.slice().forEach((e=>e.call(this,t)))}const xn=[],Sn=[];let En=[];const $n=[],Tn=Promise.resolve();let kn=!1;function Cn(){kn||(kn=!0,Tn.then(Mn))}function On(){return Cn(),Tn}function In(e){En.push(e)}const Ln=new Set;let Pn,An=0;function Mn(){if(0!==An)return;const e=fn;do{try{for(;An{Rn.delete(e),r&&(n&&e.d(1),r())})),e.o(t)}else r&&r()}const Qn={duration:0};function zn(e,t,n,r){let o,i=t(e,n,{direction:"both"}),s=r?0:1,a=null,l=null,c=null;function u(){c&&pn(e,c)}function f(e,t){const n=e.b-s;return t*=Math.abs(n),{a:s,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=vt,tick:h=bt,css:p}=i||Qn,g={start:_t()+n,b:t};t||(g.group=Fn,Fn.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=hn(e,s,t,r,n,d,p)),t&&h(0,1),a=f(g,r),In((()=>Nn(e,t,"start"))),function(e){let t;0===Qt.size&&Bt(zt),new Promise((n=>{Qt.add(t={c:e,f:n})}))}((t=>{if(l&&t>l.start&&(a=f(l,r),l=null,Nn(e,a.b,"start"),p&&(u(),c=hn(e,s,a.b,a.duration,0,d,i.css))),a)if(t>=a.end)h(s=a.b,1-s),Nn(e,a.b,"end"),l||(a.b?u():--a.group.r||Et(a.group.c)),a=null;else if(t>=a.start){const e=t-a.start;s=a.a+a.d*d(e/a.duration),h(s,1-s)}return!(!a&&!l)})))}return{run(e){$t(i)?(Pn||(Pn=Promise.resolve(),Pn.then((()=>{Pn=null}))),Pn).then((()=>{i=i({direction:e?"in":"out"}),d(e)})):d(e)},end(){u(),a=l=null}}}function Hn(e){return void 0!==e?.length?e:Array.from(e)}function Vn(e,t){e.d(1),t.delete(e.key)}function qn(e,t){Bn(e,1,1,(()=>{t.delete(e.key)}))}function Wn(e,t,n,r,o,i,s,a,l,c,u,f){let d=e.length,h=i.length,p=d;const g={};for(;p--;)g[e[p].key]=p;const m=[],y=new Map,b=new Map,v=[];for(p=h;p--;){const e=f(o,i,p),r=n(e);let a=s.get(r);a?v.push((()=>a.p(e,t))):(a=c(r,e),a.c()),y.set(r,m[p]=a),r in g&&b.set(r,Math.abs(p-g[r]))}const w=new Set,x=new Set;function S(e){_n(e,1),e.m(a,u),s.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)?!s.has(r)||w.has(r)?S(t):x.has(o)?d--:b.get(r)>b.get(o)?(x.add(r),S(t)):(w.add(o),d--):(l(n,s),d--)}for(;d--;){const t=e[d];y.has(t.key)||l(t,s)}for(;h;)S(m[h-1]);return Et(v),m}function Jn(e,t){const n={},r={},o={$$scope:1};let i=e.length;for(;i--;){const s=e[i],a=t[i];if(a){for(const e in s)e in a||(r[e]=1);for(const e in a)o[e]||(n[e]=a[e],o[e]=1);e[i]=a}else for(const e in s)o[e]=1}for(const e in r)e in n||(n[e]=void 0);return n}function Kn(e){return"object"==typeof e&&null!==e?e:{}}function Gn(e){e&&e.c()}function Zn(e,t,n){const{fragment:r,after_update:o}=e.$$;r&&r.m(t,n),In((()=>{const t=e.$$.on_mount.map(xt).filter($t);e.$$.on_destroy?e.$$.on_destroy.push(...t):Et(t),e.$$.on_mount=[]})),o.forEach(In)}function Yn(e,t){const n=e.$$;null!==n.fragment&&(!function(e){const t=[],n=[];En.forEach((r=>-1===e.indexOf(r)?t.push(r):n.push(r))),n.forEach((e=>e())),En=t}(n.after_update),Et(n.on_destroy),n.fragment&&n.fragment.d(t),n.on_destroy=n.fragment=null,n.ctx=[])}function Xn(e,t,n,r,o,i,s=null,a=[-1]){const l=fn;gn(e);const c=e.$$={fragment:null,ctx:[],props:i,update:bt,not_equal:o,bound:St(),on_mount:[],on_destroy:[],on_disconnect:[],before_update:[],after_update:[],context:new Map(t.context||(l?l.$$.context:[])),callbacks:St(),dirty:a,skip_bound:!1,root:t.target||l.$$.root};s&&s(c.root);let u=!1;if(c.ctx=n?n(e,t.props||{},((t,n,...r)=>{const i=r.length?r[0]:n;return c.ctx&&o(c.ctx[t],c.ctx[t]=i)&&(!c.skip_bound&&c.bound[t]&&c.bound[t](i),u&&function(e,t){-1===e.$$.dirty[0]&&(xn.push(e),Cn(),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 tr=[];function nr(e,t){return{subscribe:rr(e,t).subscribe}}function rr(e,t=bt){let n;const r=new Set;function o(t){if(Tt(e,t)&&(e=t,n)){const t=!tr.length;for(const t of r)t[1](),tr.push(t,e);if(t){for(let e=0;e{r.delete(l),0===r.size&&n&&(n(),n=null)}}}}function or(e,{store:t,animate:n=!0,clickActive:r=!0,enabled:o=!0}={}){e.dataset.closing="false";const i=e.querySelector("summary");let s,a=null;for(const t of e.children)if("SUMMARY"!==t.tagName){a=t;break}let l,c=e.open;function u(t,r,o){const i=Math.max(0,30*Math.log(Math.abs(r-t)+Number.EPSILON));n?(e.style.overflow="hidden",a&&(a.style.overflow="hidden"),s=e.animate({height:[`${t}px`,`${r}px`]},{duration:i,easing:"ease-out"}),s.onfinish=()=>{e.open=o,e.dataset.closing="false",e.style.overflow=null,a&&(a.style.overflow=null)}):(e.open=o,e.dataset.closing="false",e.style.overflow=null,a&&(a.style.overflow=null))}st(t)||(t=rr(!1)),t&&(l=lt(t,(t=>{o&&"boolean"==typeof t&&(c=t,e.open=c)}),(async e=>{o&&"boolean"==typeof e&&(c=e,await On(),d())})));const f=()=>{};function d(){if(n)if(c){const t=e.offsetHeight;s&&(s.cancel(),s.effect=null,s.onfinish=f),e.open=!0;u(t,e.offsetHeight,!0)}else{const t=e.offsetHeight;s&&(s.cancel(),s.effect=null,s.onfinish=f);const n=i.offsetHeight;e.dataset.closing="true",u(t,n,!1)}else e.open=c}function h(e){r&&o&&(e.preventDefault(),t.set(!c))}return i.addEventListener("click",h),{update(i){"boolean"==typeof i.animate&&(n=i.animate),"boolean"==typeof i.clickActive&&(r=i.clickActive),"boolean"==typeof i.enabled&&(o=i.enabled),st(i.store)&&i.store!==t&&("function"==typeof l&&l(),t=i.store,l=lt(t,(t=>{o&&"boolean"==typeof t&&(c=t,e.open=c)}),(async e=>{o&&"boolean"==typeof e&&(c=e,await On(),d())})))},destroy(){"function"==typeof l&&l(),i.removeEventListener("click",h)}}}function ir({storage:e,serialize:t=JSON.stringify,deserialize:n=JSON.parse}){function r(e,t,n){return{subscribe:o(e,t,n).subscribe}}function o(r,o,i){if(e){const i=e.getItem(r);try{i&&(o=n(i))}catch(e){}e.setItem(r,t(o))}const s=rr(o,i?function(n){return i((function(o){return e&&e.setItem(r,t(o)),n(o)}),(function(e){a(e(It(s)))}))}:void 0);function a(n){e&&e.setItem(r,t(n)),s.set(n)}return{set:a,update:function(e){a(e(It(s)))},subscribe:function(e,t){return s.subscribe(e,t)}}}return{readable:r,writable:o,derived:function(t,o,i,s){const a=!Array.isArray(o),l=a?[o]:o;if(e&&e.getItem(t))try{s=n(e.getItem(t))}catch(e){}return r(t,s,((e,t)=>{let n=!1;const r=[];let o,s=0;const c=()=>{if(s)return;o?.();const n=a?r[0]:r;if(i.length<2)e(i(n));else{const r=i(n,e,t);"function"==typeof r&&(o=r)}},u=l.map(((e,t)=>e.subscribe((e=>{r[t]=e,s&=~(1<{s|=1<e())),o?.()}}))},storage:e,serialize:t,deserialize:n}}const sr=ir({storage:globalThis?.localStorage}),ar=ir({storage:globalThis?.sessionStorage});class lr{#p;#g=new Map;constructor(e){this.#p=e}#m(e,t=void 0,n){try{const r=this.#p.storage.getItem(e);if(null!==r){t=(n?.deserialize??this.#p.deserialize)(r)}}catch(e){}return(n?.writable??this.#p.writable)(e,t)}#y(e){return this.#g.get(e)?.deserialize??this.#p.deserialize}#b(e){return this.#g.get(e)?.serialize??this.#p.serialize}#v(e,t=void 0,n){const r=this.#g.get(e);if(r)return r.store;const o=this.#m(e,t,n);return this.#g.set(e,{store:o,deserialize:n?.deserialize,serialize:n?.serialize}),o}getItem(e,t){let n=t;const r=this.#p.storage.getItem(e);if(null!==r)try{n=this.#y(e)(r)}catch(e){n=t}else if(void 0!==t)try{const n=this.#b(e)(t);this.#p.storage.setItem(e,n)}catch(e){}return n}getStore(e,t,n){return this.#v(e,t,n)}hasStore(e){return this.#g.has(e)}setItem(e,t){this.#v(e).set(t)}swapItemBoolean(e,t){const n=this.#v(e,t);let r=!1;try{r=!!this.#y(e)(this.#p.storage.getItem(e))}catch(e){}const o="boolean"==typeof r&&!r;return n.set(o),o}*entries(e=void 0){if(void 0!==e&&!dt.isRegExp(e))throw new TypeError("'regex' is not a RegExp");if(this.#g.size)if(e)for(const t of this.#g.keys())e.test(t)&&(yield[t,this.getStore(t)]);else for(const e of this.#g.keys())yield[e,this.getStore(e)]}*keys(e=void 0){if(void 0!==e&&!dt.isRegExp(e))throw new TypeError("'regex' is not a RegExp");if(this.#g.size)if(e)for(const t of this.#g.keys())e.test(t)&&(yield t);else for(const e of this.#g.keys())yield e}*stores(e=void 0){if(void 0!==e&&!dt.isRegExp(e))throw new TypeError("'regex' is not a RegExp");if(this.#g.size)if(e)for(const t of this.#g.keys())e.test(t)&&(yield this.getStore(t));else for(const e of this.#g.keys())yield this.getStore(e)}}class cr extends lr{constructor(){super(sr)}}class ur extends lr{constructor(){super(ar)}}class fr{static#w=[];static#x=new ur;static#S;static get sessionStorage(){return this.#x}static initialize(e){globalThis.requestAnimationFrame((()=>{this.#E(e.storagePrepend),e.settingStores.themeAnimate.subscribe((e=>this.#$(e)))}))}static openOnThisPage({focus:e=!0}={}){const t=globalThis.document.querySelector("details.tsd-page-navigation");if(t){const n=t.querySelector("summary");n&&(this.#x.hasStore(this.#S)&&this.#x.getStore(this.#S).set(!0),e&&setTimeout((()=>n.focus({focusVisible:!0})),0))}}static#E(e){const t=document.querySelectorAll("details.tsd-accordion"),n=new Map;for(const r of t){const t=r.querySelector("summary");let o;if(t&&(o=`${e}-accordion-${t.dataset.key??t.textContent?.trim?.()?.replace(/\s+/g,"-").toLowerCase()}`),o===`${e}-accordion-on-this-page`&&(this.#S=o),"string"==typeof o&&o.length){const e=n.get(o);e?e.add(r):n.set(o,new Set([r]))}}const r=globalThis.location.hash;for(const[e,t]of n){const n=this.#x.getStore(e,!0);if(r)for(const e of t){Array.from(e.querySelectorAll("*")).find((e=>`#${e.id}`===r))&&n.set(!0)}for(const e of t)this.#w.push(or(e,{store:n})),e.addEventListener("toggle",(e=>n.set(e.target.open)))}setTimeout((()=>{for(const e of n.values())for(const t of e){const e=t.querySelector("summary svg");e&&e.classList.add("dmt-summary-svg")}}),500)}static#$(e){for(const t of this.#w)t?.update({animate:e})}}class dr{static#T=!1;static get debug(){return this.#T}static set debug(e){if("boolean"!=typeof e)throw new TypeError("'debug' is not a boolean.");this.#T=e}static get prefersReducedMotion(){return globalThis?.matchMedia("(prefers-reduced-motion: reduce)")?.matches??!1}static applyFocusSource(e){if(!ut(e))return;const t=ut(e?.focusSource)?e.focusSource:e;setTimeout((()=>{const e="boolean"==typeof t.debug?this.debug||t.debug:this.debug;if(ct(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,parentHidden:o=!1,selectors:i}={}){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&&!ct(n))throw new TypeError("'ignoreClasses' is not an iterable list.");if(void 0!==r&&!dt.isSet(r))throw new TypeError("'ignoreElements' is not a Set.");if(void 0!==i&&"string"!=typeof i)throw new TypeError("'selectors' is not a string.");const s=i??this.#k(t);let a=[...e.querySelectorAll(s)];return a=r&&n?a.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?a.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?a.filter((e=>!r.has(e)&&"none"!==e.style.display&&"hidden"!==e.style.visibility&&!e.hasAttribute("disabled")&&!e.hasAttribute("inert")&&"true"!==e.getAttribute("aria-hidden"))):a.filter((e=>"none"!==e.style.display&&"hidden"!==e.style.visibility&&!e.hasAttribute("disabled")&&!e.hasAttribute("inert")&&"true"!==e.getAttribute("aria-hidden"))),o&&(a=a.filter((t=>!this.isParentHidden(t,e)))),a}static#k(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 i="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 i&&console.debug("A11yHelper.getFocusSource debug: generated 'focusSource' without event: ",e),e}if(void 0!==e&&!dt.isUserInputEvent(e))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 s;if(e&&(dr.isFocusable(e.target)?(s=e.target,i&&console.debug("A11yHelper.getFocusSource debug: 'targetEl' set to event.target: ",s)):dr.isFocusable(e.currentTarget)?(s=e.currentTarget,i&&console.debug("A11yHelper.getFocusSource debug: 'targetEl' set to event.currentTarget: ",s)):i&&(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)),s&&s?.nodeType!==Node.ELEMENT_NODE&&"function"!=typeof s?.focus))throw new TypeError("A11yHelper.getFocusSource error: 'targetEl' is not an HTMLElement or SVGElement.");const a={debug:o};if(dt.isPointerEvent(e))if(2!==e?.button&&"contextmenu"===e.type){const o=(s??e.target).getBoundingClientRect();a.source="keyboard",a.x=t??o.left+o.width/2,a.y=n??o.top+o.height/2,a.focusEl=s?[s]:[],r&&a.focusEl.push(r)}else a.source="pointer",a.x=t??e.pageX,a.y=n??e.pageY,a.focusEl=s?[s]:[],r&&a.focusEl.push(r);else{const o=s??e?.target;if(o){const e=o.getBoundingClientRect();a.source="keyboard",a.x=t??e.left+e.width/2,a.y=n??e.top+e.height/2,a.focusEl=s?[s]:[]}r&&a.focusEl.push(r)}return i&&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&&!ct(n))throw new TypeError("'ignoreClasses' is not an iterable list.");const r=e.getAttribute("contenteditable"),o="string"==typeof r&&(""===r||"true"===r),i=globalThis.parseInt(e.getAttribute("tabindex")),s=Number.isInteger(i)&&i>=0;return!!(o||s||dt.isFocusableHTMLElement(e))&&(!(t&&!s&&dt.isHTMLAnchorElement(e)&&"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){if(!ut(e)||e?.hidden||!e?.isConnected)return!1;let t=dt.getActiveElement(e);if(!t)return!1;for(;t;){if(t===e)return!0;t=t.parentElement}return!1}static isParentHidden(e,t){if(!dt.isElement(e))throw new TypeError("'element' is not an Element.");if(t=t??dt.getDocument(e)?.body,!dt.isElement(t))throw new TypeError("'stopElement' must be an Element.");let n=e.parentElement;for(;n&&n!==t;){if(0===n.offsetWidth&&0===n.offsetHeight)return!0;n=n.parentElement}return!1}}async function hr(e=1){if(!Number.isInteger(e)||e<1)throw new TypeError("nextAnimationFrame error: 'cntr' must be a positive integer greater than 0.");let t;for(;--e>=0;)t=await new Promise((e=>requestAnimationFrame(e)));return t}let pr=class{static searchPath(e,t,n){if(!e?.length)return!1;for(const n of e)if(!Array.isArray(n.children)&&n?.path===t)return!0;for(const r of e)if(Array.isArray(r.children)&&this.#C(r,t,n))return!0;return!1}static walk(e,t){for(const n of e)Array.isArray(n.children)&&this.#O(n,void 0,t)}static walkFrom(e,t){this.#O(e,void 0,t)}static#C(e,t,n){if(e.path===t)return!0;if(Array.isArray(e.children))for(const r of e.children){if(this.#C(r,t,n))return n({entry:e}),!0}return!1}static#O(e,t,n){if(Array.isArray(e.children))for(const t of e.children)this.#O(t,e,n);n({entry:e,parentEntry:t})}};class gr{#I;#L=!1;#P;#A;#M;#D;#N;constructor({currentPathURL:e,setCurrentPathURL:t,elementIndex:n,storagePrepend:r,treeName:o}){this.#A=t,this.#I=n,this.#M=r,this.#N=o,this.#P=new ur,this.#R(e),this.#F()}get elementIndex(){return this.#I}get hasData(){return this.#I?.length>0}get hasFolders(){return this.#L}get sessionStorage(){return this.#P}get storeFoldersAllOpen(){return this.#D}ensureCurrentPath(e,{setCurrent:t=!0}={}){const n=pr.searchPath(this.elementIndex,e,(({entry:e})=>{e.storageKey&&this.#P.setItem(e.storageKey,!0)}));return n&&t&&this.#A(e,this.#N),n}setChildFolderState(e,t){pr.walkFrom(e,(({entry:e})=>{e.storageKey&&this.#P.setItem(e.storageKey,t)}))}setFoldersAllOpen(e){for(const t of this.sessionStorage.stores())t.set(e)}swapFoldersAllOpen(){this.setFoldersAllOpen(!It(this.storeFoldersAllOpen))}#F(){this.#D=function(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 i=t.length<2;return nr(n,((e,n)=>{let s=!1;const a=[];let l=0,c=bt;const u=()=>{if(l)return;c();const o=t(r?a[0]:a,e,n);i?e(o):c=$t(o)?o:bt},f=o.map(((e,t)=>Ot(e,(e=>{a[t]=e,l&=~(1<{l|=1<t(!!e.reduce(((e,t)=>e&t),!0))))}#U(e){return pr.searchPath(this.elementIndex,e,(({entry:e})=>{e.storageKey&&this.#P.setItem(e.storageKey,!0)}))}#j(){let e=0;pr.walk(this.#I,(({entry:t,parentEntry:n})=>{if(n||e++,!Array.isArray(t?.children))return;const r=n?n.path??n.text:"";t.storageKey=`${this.#M}-${t.path??`${r}-${t.text}`}`,this.#P.getStore(t.storageKey,!1)})),this.#L=e>0}#R(e){this.#j();const t=this.#U(e);if(t)this.#A(e,this.#N);else if(e.includes("#")){const n=e.split("#");if(!t){const e=n[0];e&&this.#U(e)&&this.#A(e,this.#N)}}}}class mr{#_="";#B;#Q;#z;#H;#V;#q;constructor(e,t,n){this.#Q=e,this.#B=t.initialPathURL;const{subscribe:r,update:o}=rr(this.#B);this.#z=Object.freeze({subscribe:r}),this.#H=o;const i=t.storagePrepend,s=this.#A.bind(this);this.#V=new gr({currentPathURL:this.#B,setCurrentPathURL:s,elementIndex:n?.markdown??[],storagePrepend:`${i}-markdown`,treeName:"markdown"}),this.#q=new gr({currentPathURL:this.#B,setCurrentPathURL:s,elementIndex:n?.source??[],storagePrepend:`${i}-source`,treeName:"source"}),this.#W(),globalThis.addEventListener("hashchange",this.#J.bind(this))}get activeTreeName(){return this.#_}get currentPathURL(){return this.#B}get markdown(){return this.#V}get source(){return this.#q}get storeCurrentPathURL(){return this.#z}ensureCurrentPath({pathURL:e=this.#B,focus:t=!1}={}){let n=!1;n|=this.#V.ensureCurrentPath(e),n|=this.#q.ensureCurrentPath(e),n&&t&&hr().then((()=>document.querySelector("nav.tsd-navigation")?.querySelector(`a[href*="${e}"]`)?.focus({focusVisible:!0})))}#W(){const e=this;function t(t){t.preventDefault();if(globalThis.location.href.split("#")[0]!==this.href.split("#")[0]||globalThis.location.hash!==this.hash)return void(globalThis.location.href=this.href);const n=this.href.replace(e.#Q.baseURL,"");if(!e.ensureCurrentPath({pathURL:n})&&n.includes("#")){const t=n.split("#");t[0]&&e.ensureCurrentPath({pathURL:t[0]})}}const n=document.querySelectorAll('div.col-content a[href*="#"], details.tsd-page-navigation a[href*="#"]');for(const e of n)e.addEventListener("click",t)}#J(e){const t=e.newURL.replace(this.#Q.baseURL,"");if(!this.ensureCurrentPath({pathURL:t})&&t.includes("#")){const e=t.split("#")[0];e&&this.ensureCurrentPath({pathURL:e})}}#A(e,t){switch(t){case"markdown":case"source":this.#_=t;break;default:this.#_=""}this.#B=e,this.#H((()=>e))}}class yr{#K;constructor(e,t){this.#K=new mr(this,e,t)}get treeState(){return this.#K}}var br,vr={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 - */var vr,wr=(yr||(yr=1,vr=br,function(){var e,t,n,r,o,s,i,a,l,c,u,f,d,h,p,g,m,y,b,v,w,x,S,$,k,T,E,C,I,L=function(e){var t=new L.Builder;return t.pipeline.add(L.trimmer,L.stopWordFilter,L.stemmer),t.searchPipeline.add(L.stemmer),e.call(t,t),t.build()};L.version="2.3.9", + */var wr,xr=(br||(br=1,wr=vr,function(){var e,t,n,r,o,i,s,a,l,c,u,f,d,h,p,g,m,y,b,v,w,x,S,E,$,T,k,C,O,I=function(e){var t=new I.Builder;return t.pipeline.add(I.trimmer,I.stopWordFilter,I.stemmer),t.searchPipeline.add(I.stemmer),e.call(t,t),t.build()};I.version="2.3.9", /*! * lunr.utils * Copyright (C) 2020 Oliver Nightingale */ -L.utils={},L.utils.warn=function(e){return function(t){e.console&&console.warn&&console.warn(t)}}(this),L.utils.asString=function(e){return null==e?"":e.toString()},L.utils.clone=function(e){if(null==e)return e;for(var t=Object.create(null),n=Object.keys(e),r=0;r0){var l=L.utils.clone(t)||{};l.position=[i,a],l.index=o.length,o.push(new L.Token(n.slice(i,s),l))}i=s+1}}return o},L.tokenizer.separator=/[\s\-]+/, +I.tokenizer=function(e,t){if(null==e||null==e)return[];if(Array.isArray(e))return e.map((function(e){return new I.Token(I.utils.asString(e).toLowerCase(),I.utils.clone(t))}));for(var n=e.toString().toLowerCase(),r=n.length,o=[],i=0,s=0;i<=r;i++){var a=i-s;if(n.charAt(i).match(I.tokenizer.separator)||i==r){if(a>0){var l=I.utils.clone(t)||{};l.position=[s,a],l.index=o.length,o.push(new I.Token(n.slice(s,i),l))}s=i+1}}return o},I.tokenizer.separator=/[\s\-]+/, /*! * lunr.Pipeline * Copyright (C) 2020 Oliver Nightingale */ -L.Pipeline=function(){this._stack=[]},L.Pipeline.registeredFunctions=Object.create(null),L.Pipeline.registerFunction=function(e,t){t in this.registeredFunctions&&L.utils.warn("Overwriting existing registered function: "+t),e.label=t,L.Pipeline.registeredFunctions[e.label]=e},L.Pipeline.warnIfFunctionNotRegistered=function(e){e.label&&e.label in this.registeredFunctions||L.utils.warn("Function is not registered with pipeline. This may cause problems when serialising the index.\n",e)},L.Pipeline.load=function(e){var t=new L.Pipeline;return e.forEach((function(e){var n=L.Pipeline.registeredFunctions[e];if(!n)throw new Error("Cannot load unregistered function: "+e);t.add(n)})),t},L.Pipeline.prototype.add=function(){Array.prototype.slice.call(arguments).forEach((function(e){L.Pipeline.warnIfFunctionNotRegistered(e),this._stack.push(e)}),this)},L.Pipeline.prototype.after=function(e,t){L.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)},L.Pipeline.prototype.before=function(e,t){L.Pipeline.warnIfFunctionNotRegistered(t);var n=this._stack.indexOf(e);if(-1==n)throw new Error("Cannot find existingFn");this._stack.splice(n,0,t)},L.Pipeline.prototype.remove=function(e){var t=this._stack.indexOf(e);-1!=t&&this._stack.splice(t,1)},L.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},L.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},L.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,n=0;t1&&(ie&&(n=o),i!=e);)r=n-t,o=t+Math.floor(r/2),i=this.elements[2*o];return i==e||i>e?2*o:ia?c+=2:s==a&&(t+=n[l+1]*r[c+1],l+=2,c+=2);return t},I.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},I.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),t=1,n=0;t0){var s,i=o.str.charAt(0);i in o.node.edges?s=o.node.edges[i]:(s=new L.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 L.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 L.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 L.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},L.TokenSet.fromString=function(e){for(var t=new L.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()}}, +I.TokenSet=function(){this.final=!1,this.edges={},this.id=I.TokenSet._nextId,I.TokenSet._nextId+=1},I.TokenSet._nextId=1,I.TokenSet.fromArray=function(e){for(var t=new I.TokenSet.Builder,n=0,r=e.length;n0){var i,s=o.str.charAt(0);s in o.node.edges?i=o.node.edges[s]:(i=new I.TokenSet,o.node.edges[s]=i),1==o.str.length&&(i.final=!0),r.push({node:i,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 I.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 I.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 I.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},I.TokenSet.fromString=function(e){for(var t=new I.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()}}, /*! * lunr.Index * Copyright (C) 2020 Oliver Nightingale */ -L.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},L.Index.prototype.search=function(e){return this.query((function(t){new L.QueryParser(e,t).parse()}))},L.Index.prototype.query=function(e){for(var t=new L.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;a1?1:e},L.Builder.prototype.k1=function(e){this._k1=e},L.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 L.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},L.QueryLexer.prototype.width=function(){return this.pos-this.start},L.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},L.QueryLexer.prototype.backup=function(){this.pos-=1},L.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=L.QueryLexer.EOS&&this.backup()},L.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(L.QueryLexer.TERM)),e.ignore(),e.more())return L.QueryLexer.lexText},L.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(L.QueryLexer.EDIT_DISTANCE),L.QueryLexer.lexText},L.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(L.QueryLexer.BOOST),L.QueryLexer.lexText},L.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(L.QueryLexer.TERM)},L.QueryLexer.termSeparator=L.tokenizer.separator,L.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==L.QueryLexer.EOS)return L.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return L.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(L.QueryLexer.TERM),L.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(L.QueryLexer.TERM),L.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(L.QueryLexer.PRESENCE),L.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(L.QueryLexer.PRESENCE),L.QueryLexer.lexText;if(t.match(L.QueryLexer.termSeparator))return L.QueryLexer.lexTerm}else e.escapeCharacter()}},L.QueryParser=function(e,t){this.lexer=new L.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},L.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=L.QueryParser.parseClause;e;)e=e(this);return this.query},L.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},L.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},L.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},L.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case L.QueryLexer.PRESENCE:return L.QueryParser.parsePresence;case L.QueryLexer.FIELD:return L.QueryParser.parseField;case L.QueryLexer.TERM:return L.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 L.QueryParseError(n,t.start,t.end)}},L.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=L.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=L.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+t.str+"'";throw new L.QueryParseError(n,t.start,t.end)}var r=e.peekLexeme();if(null==r)throw n="expecting term or field, found nothing",new L.QueryParseError(n,t.start,t.end);switch(r.type){case L.QueryLexer.FIELD:return L.QueryParser.parseField;case L.QueryLexer.TERM:return L.QueryParser.parseTerm;default:throw n="expecting term or field, found '"+r.type+"'",new L.QueryParseError(n,r.start,r.end)}}},L.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 L.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 L.QueryParseError(r,t.start,t.end);if(o.type===L.QueryLexer.TERM)return L.QueryParser.parseTerm;throw r="expecting term, found '"+o.type+"'",new L.QueryParseError(r,o.start,o.end)}},L.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 L.QueryLexer.TERM:return e.nextClause(),L.QueryParser.parseTerm;case L.QueryLexer.FIELD:return e.nextClause(),L.QueryParser.parseField;case L.QueryLexer.EDIT_DISTANCE:return L.QueryParser.parseEditDistance;case L.QueryLexer.BOOST:return L.QueryParser.parseBoost;case L.QueryLexer.PRESENCE:return e.nextClause(),L.QueryParser.parsePresence;default:var r="Unexpected lexeme type '"+n.type+"'";throw new L.QueryParseError(r,n.start,n.end)}else e.nextClause()}},L.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 L.QueryParseError(r,t.start,t.end)}e.currentClause.editDistance=n;var o=e.peekLexeme();if(null!=o)switch(o.type){case L.QueryLexer.TERM:return e.nextClause(),L.QueryParser.parseTerm;case L.QueryLexer.FIELD:return e.nextClause(),L.QueryParser.parseField;case L.QueryLexer.EDIT_DISTANCE:return L.QueryParser.parseEditDistance;case L.QueryLexer.BOOST:return L.QueryParser.parseBoost;case L.QueryLexer.PRESENCE:return e.nextClause(),L.QueryParser.parsePresence;default:throw r="Unexpected lexeme type '"+o.type+"'",new L.QueryParseError(r,o.start,o.end)}else e.nextClause()}},L.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 L.QueryParseError(r,t.start,t.end)}e.currentClause.boost=n;var o=e.peekLexeme();if(null!=o)switch(o.type){case L.QueryLexer.TERM:return e.nextClause(),L.QueryParser.parseTerm;case L.QueryLexer.FIELD:return e.nextClause(),L.QueryParser.parseField;case L.QueryLexer.EDIT_DISTANCE:return L.QueryParser.parseEditDistance;case L.QueryLexer.BOOST:return L.QueryParser.parseBoost;case L.QueryLexer.PRESENCE:return e.nextClause(),L.QueryParser.parsePresence;default:throw r="Unexpected lexeme type '"+o.type+"'",new L.QueryParseError(r,o.start,o.end)}else e.nextClause()}},vr.exports=L}()),br.exports);function xr(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($r(e.substring(s,i)),`${$r(e.substring(i,i+r.length))}`),s=i+r.length,i=n.indexOf(r,s);return o.push($r(e.substring(s))),o.join("")}const Sr={"&":"&","<":"<",">":">","'":"'",'"':"""};function $r(e){return e.replace(/[&<>"']/g,(e=>Sr[e]))}class kr{static async getDimensions(e,{accessor:t="url",warn:n=!1}={}){const r=[],o=[],s=[],i=ct(e)?e:[e];for(const e of i){let o;"string"==typeof e?o=e:ut(e)&&(o=ft(e,t)),"string"==typeof o?r.push(new Promise(((e,t)=>{const n=new Image;n.src=o,n.onload=()=>e({url:o,width:n.naturalWidth,height:n.naturalHeight}),n.onerror=()=>t({url:o})}))):n&&console.warn("ImageData.getDimensions warning: Failed to locate target URL.")}const a=await Promise.allSettled(r);for(const e of a)switch(e.status){case"fulfilled":o.push(e.value);break;case"rejected":s.push(e.reason)}return{fulfilled:o,rejected:s}}}function Tr(e,t){const n={icons:[],totalWidth:0},r=[];r.push(...t?.iconLinks?.user??[]),r.push(...t?.iconLinks?.service??[]);for(const t of r)n.icons.push({iconURL:"string"==typeof t.dmtPath?`${e.dmtURL}${t.dmtPath}`:t.iconURL,title:t.title,url:t.url});const o=nr(n),s=`${e.storagePrepend}-toolbar-iconlinks-width`;if(0===n.icons.length)globalThis.sessionStorage.removeItem(s);else{const t=e.dmtSessionStorage.getItem(s);Number.isFinite(t)&&t>0?n.totalWidth=t:kr.getDimensions(n.icons,{accessor:"iconURL"}).then((({fulfilled:t,rejected:r})=>{r.length?globalThis.sessionStorage.removeItem(s):(o.update((e=>{for(const n of t){const t=24/n.height*n.width;e.totalWidth+=t+8}return e.totalWidth+=dt.remPixels(.35)*(t.length-1),e})),e.dmtSessionStorage.setItem(s,Math.floor(n.totalWidth)))}))}return o}const Er="docs-dmt-theme-animate";function Cr(e){let t,n,r,o,s,i,a,l,c,u,f;return{c(){t=Kt("label"),n=Kt("input"),r=Yt(),o=Gt("svg"),s=Gt("rect"),i=Gt("path"),a=Yt(),l=Kt("span"),c=Zt(e[1]),nn(n,"type","checkbox"),nn(n,"class","svelte-1y7unmi"),nn(s,"class","tsd-checkbox-background"),nn(s,"width","30"),nn(s,"height","30"),nn(s,"x","1"),nn(s,"y","1"),nn(s,"rx","6"),nn(s,"fill","none"),nn(i,"class","tsd-checkbox-checkmark"),nn(i,"d","M8.35422 16.8214L13.2143 21.75L24.6458 10.25"),nn(i,"stroke","none"),nn(i,"stroke-width","3.5"),nn(i,"stroke-linejoin","round"),nn(i,"fill","none"),nn(o,"width","32"),nn(o,"height","32"),nn(o,"viewBox","0 0 32 32"),nn(o,"aria-hidden","true"),nn(o,"class","svelte-1y7unmi"),nn(t,"class","svelte-1y7unmi")},m(d,h){Wt(d,t,h),Ht(t,n),n.checked=e[2],Ht(t,r),Ht(t,o),Ht(o,s),Ht(o,i),Ht(t,a),Ht(t,l),Ht(l,c),u||(f=en(n,"change",e[3]),u=!0)},p(e,[t]){4&t&&(n.checked=e[2]),2&t&&rn(c,e[1])},i:yt,o:yt,d(e){e&&Jt(t),u=!1,f()}}}function Ir(e,t,n){let r,o=yt,s=()=>(o(),o=Ct(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)}]}"undefined"!=typeof window&&(window.__svelte||(window.__svelte={v:new Set})).v.add("4");class Lr extends Xn{constructor(e){super(),Yn(this,e,Ir,Cr,kt,{store:0,label:1})}}function Pr(e){let t,n,r=at(e[0].themeAnimate),o=r&&function(e){let t,n,r;return n=new Lr({props:{store:e[0].themeAnimate,label:"Animation"}}),{c(){t=Kt("section"),Kn(n.$$.fragment),nn(t,"class","svelte-20evnz")},m(e,o){Wt(e,t,o),Gn(n,t,null),r=!0},p:yt,i(e){r||(jn(n.$$.fragment,e),r=!0)},o(e){Bn(n.$$.fragment,e),r=!1},d(e){e&&Jt(t),Zn(n)}}}(e);return{c(){o&&o.c(),t=Xt()},m(e,r){o&&o.m(e,r),Wt(e,t,r),n=!0},p(e,[t]){r&&o.p(e,t)},i(e){n||(jn(o),n=!0)},o(e){Bn(o),n=!1},d(e){e&&Jt(t),o&&o.d(e)}}}function Or(e){const{settingStores:t}=bn("#dmtComponentData");return[t]}function Ar(e,t){function n(){if(ut(t))for(const n of Object.keys(t))e.style.setProperty(`${n}`,t[n])}return n(),{update:e=>{t=e,n()}}}class Mr{static isComponent(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)}static isHMRProxy(e){const t=e?.constructor?.name;if("string"==typeof t&&(t.startsWith("Proxy<")||"ProxyComponent"===t))return!0;const n=e?.prototype?.constructor?.name;return"string"==typeof n&&(n.startsWith("Proxy<")||"ProxyComponent"===n)}static async outroAndDestroy(e){return null==e?Promise.resolve():new Promise((t=>{e?.$$?.fragment&&e?.$$?.fragment?.o?(Nn(),Bn(e.$$.fragment,0,0,(()=>{e?.$destroy?.(),t()})),Un()):(e?.$destroy?.(),t())}))}}Object.seal(Mr);function Dr(e,t){return e}Object.seal(class{static isConfig(e,{raiseException:t=!1}={}){if(!ut(e)){if(t)throw new TypeError("TJSSvelteConfigUtil.isConfig error: 'config' is not an object.");return!1}if(!Mr.isComponent(e.class)){if(t)throw new TypeError("TJSSvelteConfigUtil.isConfig error: 'config.class' is not a Svelte component constructor.");return!1}return!0}static parseConfig(e,t=void 0){if(!ut(e))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'config' is not an object:\n${JSON.stringify(e)}.`);if(!Mr.isComponent(e.class))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component constructor for config:\n${JSON.stringify(e)}.`);if(void 0!==e.hydrate&&"boolean"!=typeof e.hydrate)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'hydrate' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.intro&&"boolean"!=typeof e.intro)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'intro' is not a boolean for config:\n${JSON.stringify(e)}.`);if(!(void 0===e.target||"string"==typeof e.target||e.target instanceof Element||e.target instanceof ShadowRoot||e.target instanceof DocumentFragment))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'target' is not a Element, ShadowRoot, or DocumentFragment for config:\n${JSON.stringify(e)}.`);if(!(void 0===e.anchor||"string"==typeof e.anchor||e.anchor instanceof Element||e.anchor instanceof ShadowRoot||e.anchor instanceof DocumentFragment))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'anchor' is not a string, Element for config:\n${JSON.stringify(e)}.`);if(!(void 0===e.context||"function"==typeof e.context||e.context instanceof Map||ut(e.context)))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'context' is not a Map, function or object for config:\n${JSON.stringify(e)}.`);if(void 0!==e.selectorTarget&&"string"!=typeof e.selectorTarget)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'selectorTarget' is not a string for config:\n${JSON.stringify(e)}.`);if(void 0!==e.options&&!ut(e.options))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options' is not an object for config:\n${JSON.stringify(e)}.`);if(ut(e.options)){if(void 0!==e.options.injectApp&&"boolean"!=typeof e.options.injectApp)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options.injectApp' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.options.injectEventbus&&"boolean"!=typeof e.options.injectEventbus)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options.injectEventbus' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.options.selectorElement&&"string"!=typeof e.options.selectorElement)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'selectorElement' is not a string for config:\n${JSON.stringify(e)}.`)}const n={...e};delete n.options;let r={};if("function"==typeof n.context){const o=n.context;delete n.context;const s=o.call(t);if(!ut(s))throw new Error(`TJSSvelteConfigUtil.parseConfig - 'context' is a function that did not return an object for config:\n${JSON.stringify(e)}`);r={...s}}else n.context instanceof Map?(r=Object.fromEntries(n.context),delete n.context):ut(n.context)&&(r=n.context,delete n.context);if(n.props=this.#q(n.props,t,e),Array.isArray(n.children)){const o=[];for(let r=0;r0&&(r.children=o),delete n.children}else if(ut(n.children)){if(!Mr.isComponent(n.children.class))throw new Error(`TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component for children object for config:\n${JSON.stringify(e)}`);n.children.props=this.#q(n.children.props,t,e),r.children=[n.children],delete n.children}return n.context instanceof Map||(n.context=new Map),n.context.set("#external",r),n}static#q(e,t,n){if("function"==typeof e){const r=e.call(t);if(ut(r))return r;throw new Error(`TJSSvelteConfigUtil.parseConfig - 'props' is a function that did not return an object for config:\n${JSON.stringify(n)}`)}if(ut(e))return e;if(void 0!==e)throw new Error(`TJSSvelteConfigUtil.parseConfig - 'props' is not a function or an object for config:\n${JSON.stringify(n)}`);return{}}});const Rr=e=>({}),Fr=e=>({}),Nr=e=>({}),Ur=e=>({});function jr(e){let t;return{c(){t=Kt("div"),nn(t,"class","tjs-folder-focus-indicator svelte-1kxmj7q")},m(e,n){Wt(e,t,n)},d(e){e&&Jt(t)}}}function Br(e){let t,n,r=Dr(e[3])+"";return{c(){t=Kt("div"),n=Zt(r),nn(t,"class","label svelte-1kxmj7q")},m(r,o){Wt(r,t,o),Ht(t,n),e[37](t)},p(e,t){8&t[0]&&r!==(r=Dr(e[3])+"")&&rn(n,r)},i:yt,o:yt,d(n){n&&Jt(t),e[37](null)}}}function _r(e){let t,n,r;const o=[ut(e[6]?.slotLabel?.props)?e[6].slotLabel.props:{}];var s=e[6].slotLabel.class;function i(e,t){let n={};for(let e=0;e{Zn(e,1)})),Un()}s?(t=ln(s,i(e,r)),Kn(t.$$.fragment),jn(t.$$.fragment,1),Gn(t,n.parentNode,n)):t=null}else if(s){const n=64&r[0]?Wn(o,[Jn(ut(e[6]?.slotLabel?.props)?e[6].slotLabel.props:{})]):{};t.$set(n)}},i(e){r||(t&&jn(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Jt(n),t&&Zn(t,e)}}}function Qr(e){let t,n,r;const o=[ut(e[6]?.slotSummaryEnd?.props)?e[6].slotSummaryEnd.props:{}];var s=e[6].slotSummaryEnd.class;function i(e,t){let n={};for(let e=0;e{Zn(e,1)})),Un()}s?(t=ln(s,i(e,r)),Kn(t.$$.fragment),jn(t.$$.fragment,1),Gn(t,n.parentNode,n)):t=null}else if(s){const n=64&r[0]?Wn(o,[Jn(ut(e[6]?.slotSummaryEnd?.props)?e[6].slotSummaryEnd.props:{})]):{};t.$set(n)}},i(e){r||(t&&jn(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Jt(n),t&&Zn(t,e)}}}function zr(e){let t,n,r;const o=[ut(e[6]?.slotDefault?.props)?e[6].slotDefault.props:{}];var s=e[6].slotDefault.class;function i(e,t){let n={};for(let e=0;e{Zn(e,1)})),Un()}s?(t=ln(s,i(e,r)),Kn(t.$$.fragment),jn(t.$$.fragment,1),Gn(t,n.parentNode,n)):t=null}else if(s){const n=64&r[0]?Wn(o,[Jn(ut(e[6]?.slotDefault?.props)?e[6].slotDefault.props:{})]):{};t.$set(n)}},i(e){r||(t&&jn(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Jt(n),t&&Zn(t,e)}}}function Hr(e){let t,n,r,o,s,i,a,l,c,u,f,d,h,p,g,m,y=e[9].focusIndicator&&jr();const b=e[28].label,v=Pt(b,e,e[27],Ur),w=v||function(e){let t,n,r,o,s;const i=[_r,Br],a=[];function l(e,n){return 64&n[0]&&(t=null),null==t&&(t=!!Mr.isComponent(e[6]?.slotLabel?.class)),t?0:1}return n=l(e,[-1,-1]),r=a[n]=i[n](e),{c(){r.c(),o=Xt()},m(e,t){a[n].m(e,t),Wt(e,o,t),s=!0},p(e,t){let s=n;n=l(e,t),n===s?a[n].p(e,t):(Nn(),Bn(a[s],1,1,(()=>{a[s]=null})),Un(),r=a[n],r?r.p(e,t):(r=a[n]=i[n](e),r.c()),jn(r,1),r.m(o.parentNode,o))},i(e){s||(jn(r),s=!0)},o(e){Bn(r),s=!1},d(e){e&&Jt(o),a[n].d(e)}}}(e),x=e[28]["summary-end"],S=Pt(x,e,e[27],Fr),$=S||function(e){let t,n,r=Mr.isComponent(e[6]?.slotSummaryEnd?.class),o=r&&Qr(e);return{c(){o&&o.c(),t=Xt()},m(e,r){o&&o.m(e,r),Wt(e,t,r),n=!0},p(e,n){64&n[0]&&(r=Mr.isComponent(e[6]?.slotSummaryEnd?.class)),r?o?(o.p(e,n),64&n[0]&&jn(o,1)):(o=Qr(e),o.c(),jn(o,1),o.m(t.parentNode,t)):o&&(Nn(),Bn(o,1,1,(()=>{o=null})),Un())},i(e){n||(jn(o),n=!0)},o(e){Bn(o),n=!1},d(e){e&&Jt(t),o&&o.d(e)}}}(e),k=e[28].default,T=Pt(k,e,e[27],null),E=T||function(e){let t,n,r=Mr.isComponent(e[6]?.slotDefault?.class),o=r&&zr(e);return{c(){o&&o.c(),t=Xt()},m(e,r){o&&o.m(e,r),Wt(e,t,r),n=!0},p(e,n){64&n[0]&&(r=Mr.isComponent(e[6]?.slotDefault?.class)),r?o?(o.p(e,n),64&n[0]&&jn(o,1)):(o=zr(e),o.c(),jn(o,1),o.m(t.parentNode,t)):o&&(Nn(),Bn(o,1,1,(()=>{o=null})),Un())},i(e){n||(jn(o),n=!0)},o(e){Bn(o),n=!1},d(e){e&&Jt(t),o&&o.d(e)}}}(e);return{c(){t=Kt("details"),n=Kt("summary"),r=Gt("svg"),o=Gt("path"),s=Yt(),y&&y.c(),i=Yt(),w&&w.c(),a=Yt(),$&&$.c(),c=Yt(),u=Kt("div"),E&&E.c(),nn(o,"fill","currentColor"),nn(o,"stroke","currentColor"),sn(o,"stroke-linejoin","round"),sn(o,"stroke-width","3"),nn(o,"d","M5,8L19,8L12,15Z"),nn(r,"viewBox","0 0 24 24"),nn(r,"class","svelte-1kxmj7q"),an(r,"focus-chevron",e[9].focusChevron),nn(n,"role","button"),nn(n,"tabindex",l=e[1]?0:-1),nn(n,"class","svelte-1kxmj7q"),an(n,"disabled",!e[1]),an(n,"default-cursor",e[9].chevronOnly),an(n,"remove-focus-visible",e[9].focusIndicator||e[9].focusChevron),nn(u,"class","contents svelte-1kxmj7q"),nn(u,"aria-hidden",f=!e[13]),an(u,"hidden",!e[13]),nn(t,"class","tjs-svg-folder svelte-1kxmj7q"),nn(t,"data-id",e[2]),nn(t,"data-label",e[3]),nn(t,"data-closing","false")},m(l,f){Wt(l,t,f),Ht(t,n),Ht(n,r),Ht(r,o),e[36](r),Ht(n,s),y&&y.m(n,null),Ht(n,i),w&&w.m(n,null),Ht(n,a),$&&$.m(n,null),e[38](n),Ht(t,c),Ht(t,u),E&&E.m(u,null),e[39](t),p=!0,g||(m=[en(n,"click",e[14]),en(n,"contextmenu",e[15]),en(n,"keydown",e[16],!0),en(n,"keyup",e[17],!0),en(t,"close",e[18]),en(t,"open",e[19]),en(t,"toggle",e[40]),en(t,"click",e[29]),en(t,"keydown",e[30]),en(t,"keyup",e[31]),en(t,"open",e[32]),en(t,"close",e[33]),en(t,"openAny",e[34]),en(t,"closeAny",e[35]),Nt(d=rr.call(null,t,{store:e[4],animate:e[0],clickActive:!1})),Nt(h=Ar.call(null,t,e[5]))],g=!0)},p(e,o){(!p||512&o[0])&&an(r,"focus-chevron",e[9].focusChevron),e[9].focusIndicator?y||(y=jr(),y.c(),y.m(n,i)):y&&(y.d(1),y=null),v?v.p&&(!p||134217728&o[0])&&Mt(v,b,e,e[27],p?At(b,e[27],o,Nr):Dt(e[27]),Ur):w&&w.p&&(!p||1096&o[0])&&w.p(e,p?o:[-1,-1]),S?S.p&&(!p||134217728&o[0])&&Mt(S,x,e,e[27],p?At(x,e[27],o,Rr):Dt(e[27]),Fr):$&&$.p&&(!p||64&o[0])&&$.p(e,p?o:[-1,-1]),(!p||2&o[0]&&l!==(l=e[1]?0:-1))&&nn(n,"tabindex",l),(!p||2&o[0])&&an(n,"disabled",!e[1]),(!p||512&o[0])&&an(n,"default-cursor",e[9].chevronOnly),(!p||512&o[0])&&an(n,"remove-focus-visible",e[9].focusIndicator||e[9].focusChevron),T?T.p&&(!p||134217728&o[0])&&Mt(T,k,e,e[27],p?At(k,e[27],o,null):Dt(e[27]),null):E&&E.p&&(!p||64&o[0])&&E.p(e,p?o:[-1,-1]),(!p||8192&o[0]&&f!==(f=!e[13]))&&nn(u,"aria-hidden",f),(!p||8192&o[0])&&an(u,"hidden",!e[13]),(!p||4&o[0])&&nn(t,"data-id",e[2]),(!p||8&o[0])&&nn(t,"data-label",e[3]),d&&$t(d.update)&&17&o[0]&&d.update.call(null,{store:e[4],animate:e[0],clickActive:!1}),h&&$t(h.update)&&32&o[0]&&h.update.call(null,e[5])},i(e){p||(jn(w,e),jn($,e),jn(E,e),p=!0)},o(e){Bn(w,e),Bn($,e),Bn(E,e),p=!1},d(n){n&&Jt(t),e[36](null),y&&y.d(),w&&w.d(n),$&&$.d(n),e[38](null),E&&E.d(n),e[39](null),g=!1,St(m)}}}function qr(e,t,n){let r,o=yt,s=()=>(o(),o=Ct(g,(e=>n(8,r=e))),g);e.$$.on_destroy.push((()=>o()));let{$$slots:i={},$$scope:a}=t,{folder:l}=t,{animate:c}=t,{enabled:u}=t,{id:f}=t,{label:d}=t,{keyCode:h}=t,{options:p}=t,{store:g}=t;s();let{styles:m}=t,{onClose:y}=t,{onOpen:b}=t,{onContextMenu:v}=t;const w={chevronOnly:!1,focusChevron:!1,focusIndicator:!1};let x,S,$,k,T,E,C=r;var I;function L(e,t=!1){return new CustomEvent(e,{detail:{element:x,folder:l,id:f,label:d,store:g},bubbles:t})}function P(e,t=!1){const n=e.target,o=n===k||k.contains(n);if(n===$||n===S||o){if(!t&&w.chevronOnly&&!o)return e.preventDefault(),void e.stopPropagation();Ft(g,r=!r,r),r&&"function"==typeof b?b({event:e,element:x,folder:l,id:f,label:d,store:g}):r||"function"!=typeof y||y({event:e,element:x,folder:l,id:f,label:d,store:g})}e.preventDefault(),e.stopPropagation()}I=()=>T(),gn().$$.on_destroy.push(I);return e.$$set=e=>{"folder"in e&&n(6,l=e.folder),"animate"in e&&n(0,c=e.animate),"enabled"in e&&n(1,u=e.enabled),"id"in e&&n(2,f=e.id),"label"in e&&n(3,d=e.label),"keyCode"in e&&n(20,h=e.keyCode),"options"in e&&n(21,p=e.options),"store"in e&&s(n(4,g=e.store)),"styles"in e&&n(5,m=e.styles),"onClose"in e&&n(22,y=e.onClose),"onOpen"in e&&n(23,b=e.onOpen),"onContextMenu"in e&&n(24,v=e.onContextMenu),"$$scope"in e&&n(27,a=e.$$scope)},e.$$.update=()=>{65&e.$$.dirty[0]&&n(0,c=ut(l)&&"boolean"==typeof l.animate?l.animate:"boolean"!=typeof c||c),66&e.$$.dirty[0]&&n(1,u=ut(l)&&"boolean"==typeof l.enabled?l.enabled:"boolean"!=typeof u||u),68&e.$$.dirty[0]&&n(2,f=ut(l)&&"string"==typeof l.id?l.id:"string"==typeof f?f:void 0),72&e.$$.dirty[0]&&n(3,d=ut(l)&&"string"==typeof l.label?l.label:"string"==typeof d?d:""),1048640&e.$$.dirty[0]&&n(20,h=ut(l)&&"string"==typeof l.keyCode?l.keyCode:"string"==typeof h?h:"Enter"),2097216&e.$$.dirty[0]&&(n(21,p=ut(l)&&ut(l.options)?l.options:ut(p)?p:{}),"boolean"==typeof p?.chevronOnly&&n(9,w.chevronOnly=p.chevronOnly,w),"boolean"==typeof p?.focusChevron&&n(9,w.focusChevron=p.focusChevron,w),"boolean"==typeof p?.focusIndicator&&n(9,w.focusIndicator=p.focusIndicator,w)),33554640&e.$$.dirty[0]&&(s(n(4,g=ut(l)&&it(l.store)?l.store:it(g)?g:nr(!1))),"function"==typeof T&&T(),n(25,T=function(e,t){let n=!1;return e.subscribe((e=>{n?t(e):n=!0}))}(g,(e=>{x&&(x.dispatchEvent(L(e?"open":"close")),x.dispatchEvent(L(e?"openAny":"closeAny",!0)))})))),96&e.$$.dirty[0]&&n(5,m=ut(l)&&ut(l.styles)?l.styles:ut(m)?m:void 0),4194368&e.$$.dirty[0]&&n(22,y=ut(l)&&"function"==typeof l.onClose?l.onClose:"function"==typeof y?y:void 0),8388672&e.$$.dirty[0]&&n(23,b=ut(l)&&"function"==typeof l.onOpen?l.onOpen:"function"==typeof b?b:void 0),16777280&e.$$.dirty[0]&&n(24,v=ut(l)&&"function"==typeof l.onContextMenu?l.onContextMenu:"function"==typeof v?v:void 0),67109120&e.$$.dirty[0]&&(r?(clearTimeout(E),n(13,C=!0)):n(26,E=setTimeout((()=>n(13,C=!1)),500)))},[c,u,f,d,g,m,l,x,r,w,S,$,k,C,function(e){if(u)return $!==$?.ownerDocument.activeElement||-1!==e?.pointerId&&6!==e?.mozInputSource?void P(e):(e.preventDefault(),void e.stopPropagation())},function(e){u&&"function"==typeof v&&v({event:e,element:x,folder:l,id:f,label:d,store:g})},function(e){u&&$===$?.ownerDocument.activeElement&&e.code===h&&(e.preventDefault(),e.stopPropagation())},function(e){u&&$===$?.ownerDocument.activeElement&&e.code===h&&(P(e,!0),e.preventDefault(),e.stopPropagation())},function(e){e.preventDefault(),e.stopPropagation(),g.set(!1)},function(e){e.preventDefault(),e.stopPropagation(),g.set(!0)},h,p,y,b,v,T,E,a,i,function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},function(e){xn[e?"unshift":"push"]((()=>{k=e,n(12,k)}))},function(e){xn[e?"unshift":"push"]((()=>{S=e,n(10,S)}))},function(e){xn[e?"unshift":"push"]((()=>{$=e,n(11,$)}))},function(e){xn[e?"unshift":"push"]((()=>{x=e,n(7,x)}))},()=>n(7,x.open=r,x)]}class Vr extends Xn{constructor(e){super(),Yn(this,e,qr,Hr,kt,{folder:6,animate:0,enabled:1,id:2,label:3,keyCode:20,options:21,store:4,styles:5,onClose:22,onOpen:23,onContextMenu:24},null,[-1,-1])}}function Wr(e){let t,n,r=e[0].text+"";return{c(){t=Kt("span"),n=Zt(r),nn(t,"class","svelte-14yttr0"),an(t,"indent-icon","indent-icon"===e[1]),an(t,"indent-no-icon","indent-no-icon"===e[1])},m(e,r){Wt(e,t,r),Ht(t,n)},p(e,o){1&o&&r!==(r=e[0].text+"")&&rn(n,r),2&o&&an(t,"indent-icon","indent-icon"===e[1]),2&o&&an(t,"indent-no-icon","indent-no-icon"===e[1])},d(e){e&&Jt(t)}}}function Jr(e){let t,n,r,o,s,i,a=e[0].text+"",l=e[5]&&function(e){let t,n;return{c(){t=Gt("svg"),n=Gt("use"),nn(n,"href",`#icon-${e[5]}`),nn(t,"class","tsd-kind-icon svelte-14yttr0"),nn(t,"viewBox","0 0 24 24")},m(e,r){Wt(e,t,r),Ht(t,n)},p:yt,d(e){e&&Jt(t)}}}(e);return{c(){t=Kt("a"),l&&l.c(),n=Yt(),r=Kt("span"),o=Zt(a),nn(r,"class","svelte-14yttr0"),nn(t,"href",e[6]),nn(t,"data-storage-key",e[2]),nn(t,"class","svelte-14yttr0"),an(t,"current",e[3]),an(t,"indent-icon","indent-icon"===e[1]),an(t,"indent-no-icon","indent-no-icon"===e[1]),an(t,"indent-none","indent-none"===e[1])},m(a,c){var u;Wt(a,t,c),l&&l.m(t,null),Ht(t,n),Ht(t,r),Ht(r,o),s||(i=en(t,"click",tn((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+"")&&rn(o,a),4&n&&nn(t,"data-storage-key",e[2]),8&n&&an(t,"current",e[3]),2&n&&an(t,"indent-icon","indent-icon"===e[1]),2&n&&an(t,"indent-no-icon","indent-no-icon"===e[1]),2&n&&an(t,"indent-none","indent-none"===e[1])},d(e){e&&Jt(t),l&&l.d(),s=!1,i()}}}function Kr(e){let t;let n=function(e){return e[6]?Jr:Wr}(e),r=n(e);return{c(){r.c(),t=Xt()},m(e,n){r.m(e,n),Wt(e,t,n)},p(e,[t]){r.p(e,t)},i:yt,o:yt,d(e){e&&Jt(t),r.d(e)}}}function Gr(e,t,n){let r,o,{entry:s}=t,{removeIcon:i=!1}=t,{indentIcon:a}=t,{storageKey:l=null}=t;const{basePath:c,navigation:u}=bn("#dmtComponentData"),f=u.treeState.storeCurrentPathURL;Lt(e,f,(e=>n(9,o=e)));const d=!i&&s.kind?s.kind:void 0,h=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,f,d,h,function(){globalThis.location.href=h},i,o]}class Zr extends Xn{constructor(e){super(),Yn(this,e,Gr,Kr,kt,{entry:0,removeIcon:8,indentIcon:1,storageKey:2})}}function Yr(e,t,n){const r=e.slice();return r[14]=t[n],r}function Xr(e){let t,n;return t=new Zr({props:{entry:e[14],indentIcon:e[6],removeIcon:!e[2]&&2===e[14]?.kind}}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[14]),1&n&&(r.removeIcon=!e[2]&&2===e[14]?.kind),t.$set(r)},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function eo(e){let t,n;return t=new io({props:{entry:e[14],parentIcon:!e[5]}}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[14]),t.$set(r)},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function to(e,t){let n,r,o,s,i,a;const l=[eo,Xr],c=[];function u(e,t){return 1&t&&(r=null),null==r&&(r=!!Array.isArray(e[14].children)),r?0:1}return o=u(t,-1),s=c[o]=l[o](t),{key:e,first:null,c(){n=Xt(),s.c(),i=Xt(),this.first=n},m(e,t){Wt(e,n,t),c[o].m(e,t),Wt(e,i,t),a=!0},p(e,n){let r=o;o=u(t=e,n),o===r?c[o].p(t,n):(Nn(),Bn(c[r],1,1,(()=>{c[r]=null})),Un(),s=c[o],s?s.p(t,n):(s=c[o]=l[o](t),s.c()),jn(s,1),s.m(i.parentNode,i))},i(e){a||(jn(s),a=!0)},o(e){Bn(s),a=!1},d(e){e&&(Jt(n),Jt(i)),c[o].d(e)}}}function no(e){let t,n,r=[],o=new Map,s=zn(e[0].children);const i=e=>e[14].path;for(let t=0;tn(1,r=e)));const c=bn("#treeState"),u=o.storageKey,f=u?c.sessionStorage.getStore(u,!1):void 0,d=!a&&(void 0===o.kind||2===o.kind),h=d?"indent-no-icon":"indent-icon",p={store:f,options:{focusChevron:!0},styles:s?{"--tjs-folder-details-margin-left":"3.5px"}:void 0};return e.$$set=e=>{"entry"in e&&n(0,o=e.entry),"parentIcon"in e&&n(10,s=e.parentIcon)},[o,r,a,l,u,d,h,p,function(e){e?.event?.altKey&&c.setChildFolderState(o,!1)},function(e){e?.event?.altKey&&c.setChildFolderState(o,!0)},s]}class io extends Xn{constructor(e){super(),Yn(this,e,so,oo,kt,{entry:0,parentIcon:10})}}function ao(e,t,n){const r=e.slice();return r[8]=t[n],r}function lo(e){let t,n;return t=new Zr({props:{entry:e[8],indentIcon:e[4],removeIcon:!e[2]&&2===e[8]?.kind}}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[8]),1&n&&(r.removeIcon=!e[2]&&2===e[8]?.kind),t.$set(r)},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function co(e){let t,n;return t=new io({props:{entry:e[8]}}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[8]),t.$set(r)},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function uo(e,t){let n,r,o,s,i,a;const l=[co,lo],c=[];function u(e,t){return 1&t&&(r=null),null==r&&(r=!!Array.isArray(e[8].children)),r?0:1}return o=u(t,-1),s=c[o]=l[o](t),{key:e,first:null,c(){n=Xt(),s.c(),i=Xt(),this.first=n},m(e,t){Wt(e,n,t),c[o].m(e,t),Wt(e,i,t),a=!0},p(e,n){let r=o;o=u(t=e,n),o===r?c[o].p(t,n):(Nn(),Bn(c[r],1,1,(()=>{c[r]=null})),Un(),s=c[o],s?s.p(t,n):(s=c[o]=l[o](t),s.c()),jn(s,1),s.m(i.parentNode,i))},i(e){a||(jn(s),a=!0)},o(e){Bn(s),a=!1},d(e){e&&(Jt(n),Jt(i)),c[o].d(e)}}}function fo(e){let t,n,r,o,s=[],i=new Map,a=zn(e[0].elementIndex);const l=e=>e[8].path;for(let t=0;tn(5,r=e)));const c=o.hasFolders?"indent-no-icon":"indent-none";return e.$$set=e=>{"treeState"in e&&n(0,o=e.treeState)},e.$$.update=()=>{34&e.$$.dirty&&r&&dr().then((()=>{const e=l.querySelector(`a[href*="${r}"]`);e&&e.scrollIntoView({block:"center",inline:"center"})}))},[o,l,i,a,c,r,function(e){xn[e?"unshift":"push"]((()=>{l=e,n(1,l)}))}]}class go extends Xn{constructor(e){super(),Yn(this,e,po,fo,kt,{treeState:0})}}function mo(e){let t,n,r,o;return r=new go({props:{treeState:e[1].treeState.markdown}}),{c(){t=Kt("hr"),n=Yt(),Kn(r.$$.fragment),nn(t,"class","svelte-wwxcg7")},m(e,s){Wt(e,t,s),Wt(e,n,s),Gn(r,e,s),o=!0},p:yt,i(e){o||(jn(r.$$.fragment,e),o=!0)},o(e){Bn(r.$$.fragment,e),o=!1},d(e){e&&(Jt(t),Jt(n)),Zn(r,e)}}}function yo(e){let t,n,r=e[1].treeState.markdown.hasData&&function(e){let t,n,r;return n=new Vr({props:{folder:e[4],animate:e[0],$$slots:{default:[mo]},$$scope:{ctx:e}}}),{c(){t=Kt("section"),Kn(n.$$.fragment),nn(t,"class","dmt-document-index svelte-wwxcg7")},m(e,o){Wt(e,t,o),Gn(n,t,null),r=!0},p(e,t){const r={};1&t&&(r.animate=e[0]),512&t&&(r.$$scope={dirty:t,ctx:e}),n.$set(r)},i(e){r||(jn(n.$$.fragment,e),r=!0)},o(e){Bn(n.$$.fragment,e),r=!1},d(e){e&&Jt(t),Zn(n)}}}(e);return{c(){r&&r.c(),t=Xt()},m(e,o){r&&r.m(e,o),Wt(e,t,o),n=!0},p(e,[t]){e[1].treeState.markdown.hasData&&r.p(e,t)},i(e){n||(jn(r),n=!0)},o(e){Bn(r),n=!1},d(e){e&&Jt(t),r&&r.d(e)}}}function bo(e,t,n){let r,o;const{dmtSessionStorage:s,navigation:i,settingStores:a,storagePrepend:l}=bn("#dmtComponentData"),c=a.themeAnimate;Lt(e,c,(e=>n(0,o=e)));const u=s.getStore(`${l}-document-index`,!0);Lt(e,u,(e=>n(5,r=e))),"markdown"===i.treeState.activeTreeName&&Ft(u,r=!0,r);return[o,i,c,u,{store:u,label:"Document Index",options:{focusChevron:!0}}]}class vo extends Xn{constructor(e){super(),Yn(this,e,bo,yo,kt,{})}}function wo(e,t,n){const r=e.slice();return r[2]=t[n],r}function xo(e,t){let n,r;return{key:e,first:null,c(){n=Kt("a"),r=Kt("span"),r.textContent=`${t[2]}`,nn(n,"href",`${t[0][t[2]]}`),nn(n,"target","_blank"),nn(n,"class","svelte-ietkuq"),this.first=n},m(e,t){Wt(e,n,t),Ht(n,r)},p(e,n){t=e},d(e){e&&Jt(n)}}}function So(e){let t,n=e[1]&&function(e){let t,n=[],r=new Map,o=zn(Object.keys(e[0]));const s=e=>e[0][e[2]];for(let t=0;t0]}class ko extends Xn{constructor(e){super(),Yn(this,e,$o,So,kt,{})}}function To(e){const t=e*e;return e<4/11?7.5625*t:e<8/11?9.075*t-9.9*e+3.4:e<.9?4356/361*t-35442/1805*e+16061/1805:10.8*e*e-20.52*e+10.72}function Eo(e){const t=e-1;return t*t*t+1}function Co(e){return e*e*e*e*e}const Io=Object.freeze({__proto__:null,backIn:function(e){const t=1.70158;return e*e*((t+1)*e-t)},backInOut:function(e){const t=2.5949095;return(e*=2)<1?e*e*((t+1)*e-t)*.5:.5*((e-=2)*e*((t+1)*e+t)+2)},backOut:function(e){const t=1.70158;return--e*e*((t+1)*e+t)+1},bounceIn:function(e){return 1-To(1-e)},bounceInOut:function(e){return e<.5?.5*(1-To(1-2*e)):.5*To(2*e-1)+.5},bounceOut:To,circIn:function(e){return 1-Math.sqrt(1-e*e)},circInOut:function(e){return(e*=2)<1?-.5*(Math.sqrt(1-e*e)-1):.5*(Math.sqrt(1-(e-=2)*e)+1)},circOut:function(e){return Math.sqrt(1- --e*e)},cubicIn:function(e){return e*e*e},cubicInOut:function(e){return e<.5?4*e*e*e:.5*Math.pow(2*e-2,3)+1},cubicOut:Eo,elasticIn:function(e){return Math.sin(13*e*Math.PI/2)*Math.pow(2,10*(e-1))},elasticInOut:function(e){return e<.5?.5*Math.sin(13*Math.PI/2*2*e)*Math.pow(2,10*(2*e-1)):.5*Math.sin(-13*Math.PI/2*(2*e-1+1))*Math.pow(2,-10*(2*e-1))+1},elasticOut:function(e){return Math.sin(-13*(e+1)*Math.PI/2)*Math.pow(2,-10*e)+1},expoIn:function(e){return 0===e?e:Math.pow(2,10*(e-1))},expoInOut:function(e){return 0===e||1===e?e:e<.5?.5*Math.pow(2,20*e-10):-.5*Math.pow(2,10-20*e)+1},expoOut:function(e){return 1===e?e:1-Math.pow(2,-10*e)},linear:bt,quadIn:function(e){return e*e},quadInOut:function(e){return(e/=.5)<1?.5*e*e:-.5*(--e*(e-2)-1)},quadOut:function(e){return-e*(e-2)},quartIn:function(e){return Math.pow(e,4)},quartInOut:function(e){return e<.5?8*Math.pow(e,4):-8*Math.pow(e-1,4)+1},quartOut:function(e){return Math.pow(e-1,3)*(1-e)+1},quintIn:Co,quintInOut:function(e){return(e*=2)<1?.5*e*e*e*e*e:.5*((e-=2)*e*e*e*e+2)},quintOut:function(e){return--e*e*e*e*e+1},sineIn:function(e){const t=Math.cos(e*Math.PI*.5);return Math.abs(t)<1e-14?1:1-t},sineInOut:function(e){return-.5*(Math.cos(Math.PI*e)-1)},sineOut:function(e){return Math.sin(e*Math.PI/2)}});function Lo(e,t){if("function"==typeof e)return e;const n=Io[e];return n||Io.linear}function Po(e,t){const n=Lo(t.easingFade??t.easing),r=Lo(t.easingSlide??t.easing),o=function(e,{delay:t=0,duration:n=400,easing:r=bt}={}){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=Eo,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:bt,css:e=>{const t=n(e),i=r(e);return`${s.css(i,1-i)}; ${o.css(t,1-t)}`}}}function Oo(e,t,n){const r=e.slice();return r[13]=t[n],r}function Ao(e,t){let n,r,o,s,i,a,l=t[13].key+"";return{key:e,first:null,c(){n=Kt("span"),r=Gt("svg"),o=Gt("use"),s=Yt(),i=Zt(l),a=Yt(),nn(o,"href",`#icon-${t[13].value}`),nn(r,"class","tsd-kind-icon svelte-1uxeem0"),nn(r,"viewBox","0 0 24 24"),nn(n,"class","svelte-1uxeem0"),this.first=n},m(e,t){Wt(e,n,t),Ht(n,r),Ht(r,o),Ht(n,s),Ht(n,i),Ht(n,a)},p(e,n){t=e},d(e){e&&Jt(n)}}}function Mo(e){let t,n,r,o,s,i,a,l,c,u,f,d,h,p,g,m,y,b,v,w,x,S,$,k,T,E=[],C=new Map,I=zn(e[7]);const L=e=>e[13].value;for(let t=0;tAlt + DOpen / focus "Document Index"',nn(e,"class","svelte-1uxeem0")},m(t,n){Wt(t,e,n)},d(t){t&&Jt(e)}}}(),O=e[3]&&function(){let e;return{c(){e=Kt("span"),e.innerHTML='Alt + ESource (Nav) open / close all',nn(e,"class","svelte-1uxeem0")},m(t,n){Wt(t,e,n)},d(t){t&&Jt(e)}}}(),A=e[0].modules&&function(e){let t,n,r,o,s;return{c(){t=Kt("span"),n=Kt("i"),n.textContent="Alt + M",r=Zt("Go to "),o=Zt(e[6]),s=Zt(" page"),nn(n,"class","key svelte-1uxeem0"),nn(t,"class","svelte-1uxeem0")},m(e,i){Wt(e,t,i),Ht(t,n),Ht(t,r),Ht(t,o),Ht(t,s)},p:yt,d(e){e&&Jt(t)}}}(e),M=e[0].hierarchy&&function(){let e;return{c(){e=Kt("span"),e.innerHTML='Alt + YGo to class hierarchy page',nn(e,"class","svelte-1uxeem0")},m(t,n){Wt(t,e,n)},d(t){t&&Jt(e)}}}(),D=e[1]&&function(){let e;return{c(){e=Kt("span"),e.innerHTML='AltPress when opening / closing folders to open / close all child folders.',nn(e,"class","svelte-1uxeem0")},m(t,n){Wt(t,e,n)},d(t){t&&Jt(e)}}}();return{c(){t=Kt("div"),n=Kt("span"),n.textContent="Reflection Icon Reference:",r=Yt(),o=Kt("section");for(let e=0;eAlt + CFocus main content',c=Yt(),P&&P.c(),u=Yt(),O&&O.c(),f=Yt(),d=Kt("span"),d.innerHTML='Alt + HOpen / close help',h=Yt(),p=Kt("span"),p.innerHTML='Alt + IGo to home / index page',g=Yt(),m=Kt("span"),m.innerHTML='Alt + NSource (Nav) focus selected',y=Yt(),A&&A.c(),b=Yt(),v=Kt("span"),v.innerHTML='Alt + OOpen / focus "On This Page"',w=Yt(),x=Kt("span"),x.innerHTML='Alt + SActivate search',S=Yt(),M&&M.c(),$=Yt(),D&&D.c(),nn(n,"class","title svelte-1uxeem0"),nn(o,"class","reflection-kinds svelte-1uxeem0"),nn(i,"class","title svelte-1uxeem0"),nn(l,"class","svelte-1uxeem0"),nn(d,"class","svelte-1uxeem0"),nn(p,"class","svelte-1uxeem0"),nn(m,"class","svelte-1uxeem0"),nn(v,"class","svelte-1uxeem0"),nn(x,"class","svelte-1uxeem0"),nn(t,"class","svelte-1uxeem0")},m(e,k){Wt(e,t,k),Ht(t,n),Ht(t,r),Ht(t,o);for(let e=0;e{T&&(k||(k=Qn(t,e[5],{duration:100},!0)),k.run(1))})),T=!0)},o(n){n&&(k||(k=Qn(t,e[5],{duration:100},!1)),k.run(0)),T=!1},d(e){e&&Jt(t);for(let e=0;en(8,r=e)));const h=r?Po:()=>{},p=o?"package":"module",g=[];for(const[e,t]of Object.entries(a))"number"==typeof t&&g.push({key:e,value:t});return g.sort(((e,t)=>e.key.localeCompare(t.key))),[i,c,u,f,d,h,p,g]}class Ro extends Xn{constructor(e){super(),Yn(this,e,Do,Mo,kt,{})}}function Fo(e){let t,n;return t=new Ro({}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function No(e){let t,n,r,o,s,i,a,l,c,u,f,d,h,p=e[5]>0&&function(e){let t,n,r,o,s,i,a,l,c;return{c(){t=Gt("svg"),n=Gt("symbol"),r=Gt("path"),o=Yt(),s=Kt("button"),s.innerHTML='',i=Yt(),a=Kt("button"),a.innerHTML='',nn(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"),nn(n,"id","dmt-double-icon-arrow"),nn(n,"viewBox","0 0 1024 1024"),sn(t,"display","none"),nn(t,"class","svelte-1xrvgp2"),nn(s,"title","Open All"),nn(s,"class","svelte-1xrvgp2"),nn(a,"title","Close All"),nn(a,"class","svelte-1xrvgp2")},m(u,f){Wt(u,t,f),Ht(t,n),Ht(n,r),Wt(u,o,f),Wt(u,s,f),Wt(u,i,f),Wt(u,a,f),l||(c=[en(s,"click",e[10]),en(s,"keydown",Uo),en(s,"pointerdown",tn(e[9])),en(a,"click",e[11]),en(a,"keydown",Uo),en(a,"pointerdown",tn(e[8]))],l=!0)},p:yt,d(e){e&&(Jt(t),Jt(o),Jt(s),Jt(i),Jt(a)),l=!1,St(c)}}}(e),g=e[4].hierarchy&&function(e){let t,n,r;return{c(){t=Kt("button"),t.innerHTML='',nn(t,"title","Class Hierarchy"),nn(t,"class","svelte-1xrvgp2")},m(o,s){Wt(o,t,s),n||(r=[en(t,"click",e[12]),en(t,"keydown",Uo)],n=!0)},p:yt,d(e){e&&Jt(t),n=!1,St(r)}}}(e),m=e[4].modules&&function(e){let t,n,r,o,s,i,a;return{c(){t=Kt("button"),n=Gt("svg"),r=Gt("rect"),o=Gt("rect"),s=Gt("rect"),nn(r,"x","10"),nn(r,"y","0"),nn(r,"width","12"),nn(r,"height","6"),nn(o,"x","6"),nn(o,"y","13"),nn(o,"width","20"),nn(o,"height","6"),nn(s,"x","0"),nn(s,"y","26"),nn(s,"width","32"),nn(s,"height","6"),nn(n,"width","32"),nn(n,"height","32"),nn(n,"viewBox","0 0 32 32"),nn(n,"xmlns","http://www.w3.org/2000/svg"),nn(n,"class","svelte-1xrvgp2"),nn(t,"title",e[7]),nn(t,"class","svelte-1xrvgp2")},m(l,c){Wt(l,t,c),Ht(t,n),Ht(n,r),Ht(n,o),Ht(n,s),i||(a=[en(t,"click",e[13]),en(t,"keydown",Uo)],i=!0)},p:yt,d(e){e&&Jt(t),i=!1,St(a)}}}(e),y=e[0]&&Fo();return{c(){t=Kt("section"),p&&p.c(),n=Yt(),g&&g.c(),r=Yt(),m&&m.c(),o=Yt(),s=Kt("button"),i=Gt("svg"),a=Gt("g"),l=Gt("path"),c=Gt("path"),u=Yt(),y&&y.c(),nn(l,"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"),nn(c,"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"),nn(i,"viewBox","0 0 973.1 973.1"),nn(i,"class","svelte-1xrvgp2"),nn(s,"title",e[1]),nn(s,"class","svelte-1xrvgp2"),nn(t,"class","svelte-1xrvgp2")},m(b,v){Wt(b,t,v),p&&p.m(t,null),Ht(t,n),g&&g.m(t,null),Ht(t,r),m&&m.m(t,null),Ht(t,o),Ht(t,s),Ht(s,i),Ht(i,a),Ht(a,l),Ht(a,c),Ht(t,u),y&&y.m(t,null),f=!0,d||(h=[en(s,"click",e[14]),en(s,"keydown",Uo)],d=!0)},p(e,[n]){e[5]>0&&p.p(e,n),e[4].hierarchy&&g.p(e,n),e[4].modules&&m.p(e,n),(!f||2&n)&&nn(s,"title",e[1]),e[0]?y?1&n&&jn(y,1):(y=Fo(),y.c(),jn(y,1),y.m(t,null)):y&&(Nn(),Bn(y,1,1,(()=>{y=null})),Un())},i(e){f||(jn(y),f=!0)},o(e){Bn(y),f=!1},d(e){e&&Jt(t),p&&p.d(),g&&g.d(),m&&m.d(),y&&y.d(),d=!1,St(h)}}}function Uo(e){e.repeat&&(e.stopPropagation(),e.preventDefault())}function jo(e,t,n){let r,o;const{baseURL:s,moduleIsPackage:i,navigation:a,pageIndex:l,stateStores:c}=bn("#dmtComponentData"),u=a.treeState.source.hasFolders,f=c.helpPanelVisible;Lt(e,f,(e=>n(0,o=e)));const d=i?"Package Index":"Module Index";return e.$$.update=()=>{1&e.$$.dirty&&n(1,r=o?"Close Help":"Open Help")},[o,r,s,a,l,u,f,d,function(t){vn.call(this,e,t)},function(t){vn.call(this,e,t)},()=>a.treeState.source.setFoldersAllOpen(!0),()=>a.treeState.source.setFoldersAllOpen(!1),()=>globalThis.location.href=`${s}${l.hierarchy}`,()=>globalThis.location.href=`${s}${l.modules}`,()=>Ft(f,o=!o,o)]}class Bo extends Xn{constructor(e){super(),Yn(this,e,jo,No,kt,{})}}function _o(e){let t,n,r,o,s;return n=new Bo({}),o=new go({props:{treeState:e[0].treeState.source}}),{c(){t=Kt("section"),Kn(n.$$.fragment),r=Yt(),Kn(o.$$.fragment),nn(t,"class","source-index svelte-13h1skr")},m(e,i){Wt(e,t,i),Gn(n,t,null),Ht(t,r),Gn(o,t,null),s=!0},p:yt,i(e){s||(jn(n.$$.fragment,e),jn(o.$$.fragment,e),s=!0)},o(e){Bn(n.$$.fragment,e),Bn(o.$$.fragment,e),s=!1},d(e){e&&Jt(t),Zn(n),Zn(o)}}}function Qo(e){const{navigation:t}=bn("#dmtComponentData");return[t]}class zo extends Xn{constructor(e){super(),Yn(this,e,Qo,_o,kt,{})}}function Ho(e){let t,n,r,o,s,i;return t=new ko({}),r=new vo({}),s=new zo({}),{c(){Kn(t.$$.fragment),n=Yt(),Kn(r.$$.fragment),o=Yt(),Kn(s.$$.fragment)},m(e,a){Gn(t,e,a),Wt(e,n,a),Gn(r,e,a),Wt(e,o,a),Gn(s,e,a),i=!0},p:yt,i(e){i||(jn(t.$$.fragment,e),jn(r.$$.fragment,e),jn(s.$$.fragment,e),i=!0)},o(e){Bn(t.$$.fragment,e),Bn(r.$$.fragment,e),Bn(s.$$.fragment,e),i=!1},d(e){e&&(Jt(n),Jt(o)),Zn(t,e),Zn(r,e),Zn(s,e)}}}function qo(e){let t,n,r;return{c(){t=Kt("button"),t.innerHTML='',nn(t,"class","svelte-10arjs8")},m(o,s){Wt(o,t,s),n||(r=[en(t,"click",e[3]),en(t,"pointerdown",tn(e[2]))],n=!0)},p:yt,i:yt,o:yt,d(e){e&&Jt(t),n=!1,St(r)}}}function Vo(e,t,n){let r;const{stateStores:o}=bn("#dmtComponentData"),s=o.mainSearchVisible;Lt(e,s,(e=>n(0,r=e)));return[r,s,function(t){vn.call(this,e,t)},()=>Ft(s,r=!r,r)]}class Wo extends Xn{constructor(e){super(),Yn(this,e,Vo,qo,kt,{})}}function Jo(e,t,n){const r=e.slice();return r[14]=t[n],r}function Ko(e){let t,n,r;return{c(){t=Gt("svg"),n=Gt("use"),nn(n,"href",r=`#icon-${e[14].kind}`),nn(t,"class","tsd-kind-icon"),nn(t,"viewBox","0 0 24 24")},m(e,r){Wt(e,t,r),Ht(t,n)},p(e,t){2&t&&r!==(r=`#icon-${e[14].kind}`)&&nn(n,"href",r)},d(e){e&&Jt(t)}}}function Go(e,t){let n,r,o,s,i,a,l,c=t[14].name+"",u=t[14].kind&&Ko(t);function f(){return t[8](t[14])}return{key:e,first:null,c(){n=Kt("li"),u&&u.c(),r=Yt(),o=Kt("span"),s=Yt(),nn(o,"class","parent"),nn(n,"class",i=Rt(t[14].classes)+" svelte-5rxzhp"),nn(n,"role","menuitem"),an(n,"selected",t[14].id===t[2]),this.first=n},m(e,t){Wt(e,n,t),u&&u.m(n,null),Ht(n,r),Ht(n,o),o.innerHTML=c,Ht(n,s),a||(l=en(n,"click",f),a=!0)},p(e,s){(t=e)[14].kind?u?u.p(t,s):(u=Ko(t),u.c(),u.m(n,r)):u&&(u.d(1),u=null),2&s&&c!==(c=t[14].name+"")&&(o.innerHTML=c),2&s&&i!==(i=Rt(t[14].classes)+" svelte-5rxzhp")&&nn(n,"class",i),6&s&&an(n,"selected",t[14].id===t[2])},d(e){e&&Jt(n),u&&u.d(),a=!1,l()}}}function Zo(e){let t,n,r,o=[],s=new Map,i=zn(e[1]);const a=e=>e[14].id;for(let t=0;t{r&&(n||(n=Qn(t,e[6],{duration:100},!0)),n.run(1))})),r=!0)},o(o){n||(n=Qn(t,e[6],{duration:100},!1)),n.run(0),r=!1},d(r){r&&Jt(t);for(let e=0;en(10,r=e)));const f=l.themeAnimate;Lt(e,f,(e=>n(11,o=e)));const d=bn("#storeCurrentId");Lt(e,d,(e=>n(2,s=e)));const h=o?Po:()=>{};function p(e){Ft(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,u,f,d,h,p,e=>p(e.href),function(e){xn[e?"unshift":"push"]((()=>{a=e,n(0,a)}))}]}class Xo extends Xn{constructor(e){super(),Yn(this,e,Yo,Zo,kt,{results:1,resultsEl:0})}}const{window:es}=zt;function ts(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 Xo({props:s}),xn.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(){Kn(t.$$.fragment)},m(e,n){Gn(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,$n.push(s)),t.$set(o)},i(e){r||(jn(t.$$.fragment,e),r=!0)},o(e){Bn(t.$$.fragment,e),r=!1},d(e){Zn(t,e)}}}function ns(e){let t,n,r,o,s,i,a,l=e[0].length&&ts(e);return{c(){t=Kt("input"),r=Yt(),l&&l.c(),o=Xt(),nn(t,"type","search"),nn(t,"id","dmt-search-field"),nn(t,"aria-label","Search"),nn(t,"class","svelte-tuln0o"),sn(t,"color",e[4]?"red":null),sn(t,"border-color",e[4]?"red":null)},m(n,c){Wt(n,t,c),e[11](t),on(t,e[1]),Wt(n,r,c),l&&l.m(n,c),Wt(n,o,c),s=!0,i||(a=[en(es,"pointerdown",e[10]),en(t,"input",e[12]),en(t,"keydown",e[9])],i=!0)},p(e,[n]){2&n&&t.value!==e[1]&&on(t,e[1]),16&n&&sn(t,"color",e[4]?"red":null),16&n&&sn(t,"border-color",e[4]?"red":null),e[0].length?l?(l.p(e,n),1&n&&jn(l,1)):(l=ts(e),l.c(),jn(l,1),l.m(o.parentNode,o)):l&&(Nn(),Bn(l,1,1,(()=>{l=null})),Un())},i(r){s||(r&&In((()=>{s&&(n||(n=Qn(t,e[8],{duration:200},!0)),n.run(1))})),jn(l),s=!0)},o(r){r&&(n||(n=Qn(t,e[8],{duration:200},!1)),n.run(0)),Bn(l),s=!1},d(s){s&&(Jt(t),Jt(r),Jt(o)),e[11](null),s&&n&&n.end(),l&&l.d(s),i=!1,St(a)}}}function rs(e,t,n){let r,o,s,i;const a=nr(void 0);yn("#storeCurrentId",a);const{basePath:l,showModuleIcon:c,searchOptions:u,settingStores:f,stateStores:d}=bn("#dmtComponentData"),h=d.mainSearchVisible;Lt(e,h,(e=>n(15,o=e)));const p=f.themeAnimate;Lt(e,p,(e=>n(16,i=e)));const g=u?.fullName??!1,m=u?.limit??10,y=nr("");Lt(e,y,(e=>n(1,s=e)));const b=i?Po:()=>{},v=mt.debounce(((e,t)=>n(0,k=function(e,{basePath:t,showModuleIcon: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${xr(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}(e,t))),250),w={basePath:l,showModuleIcon:c,searchFullName:g,searchLimit:m};let x,S,$=0,k=[];return mn((()=>x.focus())),e.$$.update=()=>{2&e.$$.dirty&&v(s,{...w}),1&e.$$.dirty&&k?.length&&($=-1,a.set(void 0)),3&e.$$.dirty&&n(4,r=s.length&&!k?.length)},[k,s,x,S,r,h,p,y,b,function(e){switch(e.code){case"ArrowDown":if(0===k.length)return;$0&&(a.set(k[--$].id),e.preventDefault());break;case"Enter":$>=0&&(window.location.href=k[$].href),e.preventDefault();break;case"Escape":o&&!s.length&&Ft(h,o=!1,o);break;case"Tab":if(0===k.length)return void e.preventDefault();e.shiftKey?$>0&&a.set(k[--$].id):${x=e,n(2,x)}))},function(){s=this.value,y.set(s)},function(e){S=e,n(3,S)}]}class os extends Xn{constructor(e){super(),Yn(this,e,rs,ns,kt,{})}}function ss(e){let t,n;return t=new os({}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function is(e){let t,n,r,o,s=e[0]&&ss();return r=new Wo({}),{c(){s&&s.c(),t=Yt(),n=Kt("div"),Kn(r.$$.fragment),nn(n,"class","dmt-widget dmt-toolbar-icon search no-caption svelte-wmon9h")},m(e,i){s&&s.m(e,i),Wt(e,t,i),Wt(e,n,i),Gn(r,n,null),o=!0},p(e,[n]){e[0]?s?1&n&&jn(s,1):(s=ss(),s.c(),jn(s,1),s.m(t.parentNode,t)):s&&(Nn(),Bn(s,1,1,(()=>{s=null})),Un())},i(e){o||(jn(s),jn(r.$$.fragment,e),o=!0)},o(e){Bn(s),Bn(r.$$.fragment,e),o=!1},d(e){e&&(Jt(t),Jt(n)),s&&s.d(e),Zn(r)}}}function as(e,t,n){let r;const{stateStores:o}=bn("#dmtComponentData"),s=o.mainSearchVisible;return Lt(e,s,(e=>n(0,r=e))),[r,s]}class ls extends Xn{constructor(e){super(),Yn(this,e,as,is,kt,{})}}function cs(e){let t,n,r,o;return{c(){t=Kt("div"),nn(t,"class","tjs-focus-wrap svelte-kjcljd"),nn(t,"tabindex",n=e[0]?0:null)},m(n,s){Wt(n,t,s),e[4](t),r||(o=en(t,"focus",e[2]),r=!0)},p(e,[r]){1&r&&n!==(n=e[0]?0:null)&&nn(t,"tabindex",n)},i:yt,o:yt,d(n){n&&Jt(t),e[4](null),r=!1,o()}}}function us(e,t,n){let r,o,{elementRoot:s}=t,{enabled:i=!0}=t;return e.$$set=e=>{"elementRoot"in e&&n(3,s=e.elementRoot),"enabled"in e&&n(0,i=e.enabled)},e.$$.update=()=>{2&e.$$.dirty&&o&&(r=new Set([o]))},[i,o,function(){if(i&&fr.isFocusTarget(s)){const e=fr.getFirstFocusableElement(s,r);fr.isFocusTarget(e)&&e!==o?e.focus():s.focus()}},s,function(e){xn[e?"unshift":"push"]((()=>{o=e,n(1,o)}))}]}class fs extends Xn{constructor(e){super(),Yn(this,e,us,cs,kt,{elementRoot:3,enabled:0})}}function ds(e,t,n){const r=e.slice();return r[15]=t[n],r}function hs(e,t){let n,r,o,s,i,a,l;return{key:e,first:null,c(){n=Kt("a"),r=Kt("img"),i=Yt(),Et(r.src,o=t[15].iconURL)||nn(r,"src",o),nn(r,"alt",s=t[15].title),nn(r,"class","svelte-1pcybcf"),nn(n,"href",a=t[15].url),nn(n,"target","_blank"),nn(n,"title",l=t[15].title),nn(n,"class","svelte-1pcybcf"),this.first=n},m(e,t){Wt(e,n,t),Ht(n,r),Ht(n,i)},p(e,i){t=e,2&i&&!Et(r.src,o=t[15].iconURL)&&nn(r,"src",o),2&i&&s!==(s=t[15].title)&&nn(r,"alt",s),2&i&&a!==(a=t[15].url)&&nn(n,"href",a),2&i&&l!==(l=t[15].title)&&nn(n,"title",l)},d(e){e&&Jt(n)}}}function ps(e){let t,n,r,o,s,i,a,l,c=[],u=new Map,f=zn(e[1].icons);const d=e=>e[15].url;for(let t=0;t{i&&(s||(s=Qn(t,e[4],{duration:250,easing:Co},!0)),s.run(1))})),i=!0)},o(n){Bn(o.$$.fragment,n),s||(s=Qn(t,e[4],{duration:250,easing:Co},!1)),s.run(0),i=!1},d(n){n&&Jt(t);for(let e=0;en(1,s=e)));const{themeAnimate:c}=a;Lt(e,c,(e=>n(11,o=e)));const u=o?Po:()=>{},f={ignoreClasses:["tjs-focus-wrap"]},d=bn("menuVisible");let h;return Lt(e,d,(e=>n(10,r=e))),mn((()=>h.focus())),[h,s,l,c,u,d,function(e){if("Tab"===e.code)if(e.stopPropagation(),e.shiftKey){const t=fr.getFocusableElements(h,f),n=t.length>0?t[0]:void 0,r=t.length>0?t[t.length-1]:void 0;h!==globalThis.document.activeElement&&n!==globalThis.document.activeElement||(r instanceof HTMLElement&&n!==r&&r.focus(),e.preventDefault())}e.stopPropagation()},function(e){if("Escape"===e.code)Ft(d,r=!1,r),e.preventDefault();e.stopPropagation()},function(e){h?.parentElement?.contains?.(e.target)||Ft(d,r=!1,r)},function(e){xn[e?"unshift":"push"]((()=>{h=e,n(0,h)}))}]}class ms extends Xn{constructor(e){super(),Yn(this,e,gs,ps,kt,{})}}function ys(e){let t,n;return t=new ms({props:{buttonHostEl:e[0]}}),{c(){Kn(t.$$.fragment)},m(e,r){Gn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.buttonHostEl=e[0]),t.$set(r)},i(e){n||(jn(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Zn(t,e)}}}function bs(e){let t,n,r,o,s,i,a=e[1]&&ys(e);return{c(){t=Kt("section"),n=Kt("button"),n.innerHTML='',r=Yt(),a&&a.c(),nn(n,"class","svelte-1ebh1s9"),nn(t,"class","svelte-1ebh1s9")},m(l,c){Wt(l,t,c),Ht(t,n),Ht(t,r),a&&a.m(t,null),e[5](t),o=!0,s||(i=[en(n,"click",e[4]),en(n,"pointerdown",tn(e[3]))],s=!0)},p(e,[n]){e[1]?a?(a.p(e,n),2&n&&jn(a,1)):(a=ys(e),a.c(),jn(a,1),a.m(t,null)):a&&(Nn(),Bn(a,1,1,(()=>{a=null})),Un())},i(e){o||(jn(a),o=!0)},o(e){Bn(a),o=!1},d(n){n&&Jt(t),a&&a.d(),e[5](null),s=!1,St(i)}}}function vs(e,t,n){let r;const o=nr(!1);let s;Lt(e,o,(e=>n(1,r=e))),yn("menuVisible",o);return[s,r,o,function(t){vn.call(this,e,t)},()=>Ft(o,r=!r,r),function(e){xn[e?"unshift":"push"]((()=>{s=e,n(0,s)}))}]}class ws extends Xn{constructor(e){super(),Yn(this,e,vs,bs,kt,{})}}function xs(e,t,n){const r=e.slice();return r[3]=t[n],r}function Ss(e,t){let n,r,o,s,i,a,l;return{key:e,first:null,c(){n=Kt("a"),r=Kt("img"),i=Yt(),Et(r.src,o=t[3].iconURL)||nn(r,"src",o),nn(r,"alt",s=t[3].title),nn(r,"class","svelte-1f93d1m"),nn(n,"href",a=t[3].url),nn(n,"target","_blank"),nn(n,"title",l=t[3].title),nn(n,"class","svelte-1f93d1m"),this.first=n},m(e,t){Wt(e,n,t),Ht(n,r),Ht(n,i)},p(e,i){t=e,1&i&&!Et(r.src,o=t[3].iconURL)&&nn(r,"src",o),1&i&&s!==(s=t[3].title)&&nn(r,"alt",s),1&i&&a!==(a=t[3].url)&&nn(n,"href",a),1&i&&l!==(l=t[3].title)&&nn(n,"title",l)},d(e){e&&Jt(n)}}}function $s(e){let t,n=[],r=new Map,o=zn(e[0].icons);const s=e=>e[3].url;for(let t=0;tn(0,r=e))),[r,s]}class Ts extends Xn{constructor(e){super(),Yn(this,e,ks,$s,kt,{})}}function Es(e){let t,n,r;var o=e[1];return o&&(t=ln(o,{})),{c(){t&&Kn(t.$$.fragment),n=Xt()},m(e,o){t&&Gn(t,e,o),Wt(e,n,o),r=!0},p(e,r){if(2&r&&o!==(o=e[1])){if(t){Nn();const e=t;Bn(e.$$.fragment,1,0,(()=>{Zn(e,1)})),Un()}o?(t=ln(o,{}),Kn(t.$$.fragment),jn(t.$$.fragment,1),Gn(t,n.parentNode,n)):t=null}},i(e){r||(t&&jn(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Jt(n),t&&Zn(t,e)}}}function Cs(e){let t,n,r=e[0].icons.length&&Es(e);return{c(){r&&r.c(),t=Xt()},m(e,o){r&&r.m(e,o),Wt(e,t,o),n=!0},p(e,[n]){e[0].icons.length?r?(r.p(e,n),1&n&&jn(r,1)):(r=Es(e),r.c(),jn(r,1),r.m(t.parentNode,t)):r&&(Nn(),Bn(r,1,1,(()=>{r=null})),Un())},i(e){n||(jn(r),n=!0)},o(e){Bn(r),n=!1},d(e){e&&Jt(t),r&&r.d(e)}}}function Is(e,t,n){let r,o;const{componentStores:s}=bn("#dmtComponentData"),i=bn("toolbarOffsetWidth");Lt(e,i,(e=>n(4,r=e)));const{toolbarIconLinks:a}=s;Lt(e,a,(e=>n(0,o=e)));let l=Ts;return e.$$.update=()=>{17&e.$$.dirty&&r>0&&(o.totalWidth>0&&n(1,l=o.totalWidth>r?ws:Ts),r<40&&n(1,l=void 0))},[o,l,i,a,r]}class Ls extends Xn{constructor(e){super(),Yn(this,e,Is,Cs,kt,{})}}function Ps(e){let t,n,r,o,s,i;return n=new Ls({}),{c(){t=Kt("section"),Kn(n.$$.fragment),nn(t,"class","svelte-j9157o")},m(a,l){Wt(a,t,l),Gn(n,t,null),o=!0,s||(i=Nt(r=gt.call(null,t,e[2])),s=!0)},p(e,[t]){r&&$t(r.update)&&1&t&&r.update.call(null,e[2])},i(e){o||(jn(n.$$.fragment,e),o=!0)},o(e){Bn(n.$$.fragment,e),o=!1},d(e){e&&Jt(t),Zn(n),s=!1,i()}}}function Os(e,t,n){let r;const o=nr(0);Lt(e,o,(e=>n(0,r=e))),yn("toolbarOffsetWidth",o);return[r,o,e=>Ft(o,r=e,r)]}globalThis.dmtInflateAndUnpack=function(e,{inflateOptions:t}={}){return Z(Je(e,t))},globalThis.dmtInflateAndUnpackB64=function(e,{inflateOptions:t}={}){return Z(Je(ot(st(e)),t))};const As=new class{#V;#W;#J;#K;#G;#Z;#Y={local:new lr,session:new cr};constructor(e){this.#W="string"==typeof globalThis.dmtComponentDataBCMP?globalThis.dmtInflateAndUnpackB64(globalThis.dmtComponentDataBCMP):{};const t=e.replace(/assets\/dmt\/dmt-components.js/,""),n=e.replace(/dmt-components.js/,""),r=globalThis.location.href.replace(t,""),o=(r.match(/\//)??[]).length,s="../".repeat(o);this.#J={basePath:s,baseURL:t,dmtURL:n,initialPathURL:r},this.#K=new mr(this,this.#W.navigationIndex),this.#V=Object.freeze({toolbarIconLinks:Tr(this,this.#W)});const i="boolean"!=typeof this.#W?.settingOptions?.animation||this.#W?.settingOptions?.animation;this.#G=Object.freeze({themeAnimate:i?this.#Y.local.getStore(Er,!fr.prefersReducedMotion):tr(!1)}),this.#Z=Object.freeze({helpPanelVisible:nr(!1),mainSearchVisible:nr(!1),swapHelpPanelVisible:()=>this.#Z.helpPanelVisible.set(!It(this.#Z.helpPanelVisible))})}get basePath(){return this.#J.basePath}get baseURL(){return this.#J.baseURL}get componentStores(){return this.#V}get dmtLocalStorage(){return this.#Y.local}get dmtSessionStorage(){return this.#Y.session}get dmtURL(){return this.#J.dmtURL}get initialPathURL(){return this.#J.initialPathURL}get navigation(){return this.#K}get settingStores(){return this.#G}get stateStores(){return this.#Z}get iconLinks(){return this.#W.iconLinks}get pageIndex(){return this.#W.pageIndex??{}}get moduleIsPackage(){return this.#W.moduleIsPackage??!1}get showModuleIcon(){return this.#W.showModuleIcon??!0}get searchOptions(){return this.#W.searchOptions}get ReflectionKind(){return this.#W.ReflectionKind}get sidebarLinks(){return this.#W?.sidebarLinks??{}}get storagePrepend(){return this.#W.storagePrepend??"docs-unnamed"}}(import.meta.url),Ms=new Map([["#dmtComponentData",As]]),Ds=new class extends Xn{constructor(e){super(),Yn(this,e,Or,Pr,kt,{})}}({target:document.querySelector(".tsd-navigation.settings .tsd-accordion-details"),context:Ms}),Rs=document.querySelector("nav#tsd-sidebar-links");Rs&&Rs.remove();const Fs=document.querySelector("nav.tsd-navigation");if(Fs&&Fs.firstChild)for(;Fs.firstChild;)Fs.removeChild(Fs.firstChild);const Ns=new class extends Xn{constructor(e){super(),Yn(this,e,null,Ho,kt,{})}}({target:document.querySelector("nav.tsd-navigation"),context:Ms}),Us=new class extends Xn{constructor(e){super(),Yn(this,e,Os,Ps,kt,{})}}({target:document.querySelector("#dmt-toolbar"),context:Ms});globalThis.dmtComponents={dmtSettings:Ds,navigation:Ns,toolbar:Us},As.searchOptions&&(!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=wr.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 ls({target:document.querySelector("#dmt-search-main"),context:Ms})),function(e){const{baseURL:t,dmtSessionStorage:n,pageIndex:r,navigation:o,stateStores:s,storagePrepend:i}=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=fr.getFirstFocusableElement(t);e&&e.focus({focusVisible:!0})}e.preventDefault();break}case"KeyD":{const t=`${i}-document-index`;n.hasStore(t)&&(n.getStore(t).set(!0),setTimeout((()=>{const e=globalThis.document.querySelector("section.dmt-document-index");if(e){const t=e.querySelector("a");t&&t.focus({focusVisible:!0})}}),0)),e.preventDefault();break}case"KeyE":o.treeState.source.swapFoldersAllOpen(),e.preventDefault();break;case"KeyH":s.swapHelpPanelVisible(),e.preventDefault();break;case"KeyI":globalThis.location.href=`${t}index.html`,e.preventDefault();break;case"KeyM":"string"==typeof r.modules&&(globalThis.location.href=`${t}${r.modules}`),e.preventDefault();break;case"KeyN":o.treeState.ensureCurrentPath({focus:!0}),e.preventDefault();break;case"KeyO":ur.openOnThisPage(),e.preventDefault();break;case"KeyS":s.mainSearchVisible.set(!0),e.preventDefault();break;case"KeyY":"string"==typeof r.hierarchy&&(globalThis.location.href=`${t}${r.hierarchy}`),e.preventDefault()}}))}(As),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})))}))}(),ur.initialize(As),globalThis.requestAnimationFrame((()=>{const e=document.createElement("style");e.innerHTML="body { visibility: visible; }",document.head.appendChild(e);const t=document.querySelector("body main footer");t&&document.documentElement.style.setProperty("--dmt-footer-height",`${t.offsetHeight}px`)})); +I.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=I.tokenizer,this.pipeline=new I.Pipeline,this.searchPipeline=new I.Pipeline,this.documentCount=0,this._b=.75,this._k1=1.2,this.termIndex=0,this.metadataWhitelist=[]},I.Builder.prototype.ref=function(e){this._ref=e},I.Builder.prototype.field=function(e,t){if(/\//.test(e))throw new RangeError("Field '"+e+"' contains illegal character '/'");this._fields[e]=t||{}},I.Builder.prototype.b=function(e){this._b=e<0?0:e>1?1:e},I.Builder.prototype.k1=function(e){this._k1=e},I.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 I.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},I.QueryLexer.prototype.width=function(){return this.pos-this.start},I.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},I.QueryLexer.prototype.backup=function(){this.pos-=1},I.QueryLexer.prototype.acceptDigitRun=function(){var e,t;do{t=(e=this.next()).charCodeAt(0)}while(t>47&&t<58);e!=I.QueryLexer.EOS&&this.backup()},I.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(I.QueryLexer.TERM)),e.ignore(),e.more())return I.QueryLexer.lexText},I.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(I.QueryLexer.EDIT_DISTANCE),I.QueryLexer.lexText},I.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(I.QueryLexer.BOOST),I.QueryLexer.lexText},I.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(I.QueryLexer.TERM)},I.QueryLexer.termSeparator=I.tokenizer.separator,I.QueryLexer.lexText=function(e){for(;;){var t=e.next();if(t==I.QueryLexer.EOS)return I.QueryLexer.lexEOS;if(92!=t.charCodeAt(0)){if(":"==t)return I.QueryLexer.lexField;if("~"==t)return e.backup(),e.width()>0&&e.emit(I.QueryLexer.TERM),I.QueryLexer.lexEditDistance;if("^"==t)return e.backup(),e.width()>0&&e.emit(I.QueryLexer.TERM),I.QueryLexer.lexBoost;if("+"==t&&1===e.width())return e.emit(I.QueryLexer.PRESENCE),I.QueryLexer.lexText;if("-"==t&&1===e.width())return e.emit(I.QueryLexer.PRESENCE),I.QueryLexer.lexText;if(t.match(I.QueryLexer.termSeparator))return I.QueryLexer.lexTerm}else e.escapeCharacter()}},I.QueryParser=function(e,t){this.lexer=new I.QueryLexer(e),this.query=t,this.currentClause={},this.lexemeIdx=0},I.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=I.QueryParser.parseClause;e;)e=e(this);return this.query},I.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},I.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},I.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},I.QueryParser.parseClause=function(e){var t=e.peekLexeme();if(null!=t)switch(t.type){case I.QueryLexer.PRESENCE:return I.QueryParser.parsePresence;case I.QueryLexer.FIELD:return I.QueryParser.parseField;case I.QueryLexer.TERM:return I.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 I.QueryParseError(n,t.start,t.end)}},I.QueryParser.parsePresence=function(e){var t=e.consumeLexeme();if(null!=t){switch(t.str){case"-":e.currentClause.presence=I.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=I.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+t.str+"'";throw new I.QueryParseError(n,t.start,t.end)}var r=e.peekLexeme();if(null==r)throw n="expecting term or field, found nothing",new I.QueryParseError(n,t.start,t.end);switch(r.type){case I.QueryLexer.FIELD:return I.QueryParser.parseField;case I.QueryLexer.TERM:return I.QueryParser.parseTerm;default:throw n="expecting term or field, found '"+r.type+"'",new I.QueryParseError(n,r.start,r.end)}}},I.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 I.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 I.QueryParseError(r,t.start,t.end);if(o.type===I.QueryLexer.TERM)return I.QueryParser.parseTerm;throw r="expecting term, found '"+o.type+"'",new I.QueryParseError(r,o.start,o.end)}},I.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 I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:var r="Unexpected lexeme type '"+n.type+"'";throw new I.QueryParseError(r,n.start,n.end)}else e.nextClause()}},I.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 I.QueryParseError(r,t.start,t.end)}e.currentClause.editDistance=n;var o=e.peekLexeme();if(null!=o)switch(o.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:throw r="Unexpected lexeme type '"+o.type+"'",new I.QueryParseError(r,o.start,o.end)}else e.nextClause()}},I.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 I.QueryParseError(r,t.start,t.end)}e.currentClause.boost=n;var o=e.peekLexeme();if(null!=o)switch(o.type){case I.QueryLexer.TERM:return e.nextClause(),I.QueryParser.parseTerm;case I.QueryLexer.FIELD:return e.nextClause(),I.QueryParser.parseField;case I.QueryLexer.EDIT_DISTANCE:return I.QueryParser.parseEditDistance;case I.QueryLexer.BOOST:return I.QueryParser.parseBoost;case I.QueryLexer.PRESENCE:return e.nextClause(),I.QueryParser.parsePresence;default:throw r="Unexpected lexeme type '"+o.type+"'",new I.QueryParseError(r,o.start,o.end)}else e.nextClause()}},wr.exports=I}()),vr.exports);function Sr(e,t){if(""===t)return e;const n=e.toLocaleLowerCase(),r=t.toLocaleLowerCase(),o=[];let i=0,s=n.indexOf(r);for(;-1!==s;)o.push($r(e.substring(i,s)),`${$r(e.substring(s,s+r.length))}`),i=s+r.length,s=n.indexOf(r,i);return o.push($r(e.substring(i))),o.join("")}const Er={"&":"&","<":"<",">":">","'":"'",'"':"""};function $r(e){return e.replace(/[&<>"']/g,(e=>Er[e]))}class Tr{static async getDimensions(e,{accessor:t="url",warn:n=!1}={}){const r=[],o=[],i=[],s=ct(e)?e:[e];for(const e of s){let o;"string"==typeof e?o=e:ut(e)&&(o=ft(e,t)),"string"==typeof o?r.push(new Promise(((e,t)=>{const n=new Image;n.src=o,n.onload=()=>e({url:o,width:n.naturalWidth,height:n.naturalHeight}),n.onerror=()=>t({url:o})}))):n&&console.warn("ImageData.getDimensions warning: Failed to locate target URL.")}const a=await Promise.allSettled(r);for(const e of a)switch(e.status){case"fulfilled":o.push(e.value);break;case"rejected":i.push(e.reason)}return{fulfilled:o,rejected:i}}}function kr(e,t){const n={icons:[],totalWidth:0},r=[];r.push(...t?.iconLinks?.user??[]),r.push(...t?.iconLinks?.service??[]);for(const t of r)n.icons.push({iconURL:"string"==typeof t.dmtPath?`${e.dmtURL}${t.dmtPath}`:t.iconURL,title:t.title,url:t.url});const o=rr(n),i=`${e.storagePrepend}-toolbar-iconlinks-width`;if(0===n.icons.length)globalThis.sessionStorage.removeItem(i);else{const t=e.dmtSessionStorage.getItem(i);Number.isFinite(t)&&t>0?n.totalWidth=t:Tr.getDimensions(n.icons,{accessor:"iconURL"}).then((({fulfilled:t,rejected:r})=>{r.length?globalThis.sessionStorage.removeItem(i):(o.update((e=>{for(const n of t){const t=24/n.height*n.width;e.totalWidth+=t+8}return e.totalWidth+=ht.remPixels(.35)*(t.length-1),e})),e.dmtSessionStorage.setItem(i,Math.floor(n.totalWidth)))}))}return o}const Cr="docs-dmt-theme-animate";function Or(e){let t,n,r,o,i,s,a,l,c,u,f;return{c(){t=Gt("label"),n=Gt("input"),r=Xt(),o=Zt("svg"),i=Zt("rect"),s=Zt("path"),a=Xt(),l=Gt("span"),c=Yt(e[1]),rn(n,"type","checkbox"),rn(n,"class","svelte-1y7unmi"),rn(i,"class","tsd-checkbox-background"),rn(i,"width","30"),rn(i,"height","30"),rn(i,"x","1"),rn(i,"y","1"),rn(i,"rx","6"),rn(i,"fill","none"),rn(s,"class","tsd-checkbox-checkmark"),rn(s,"d","M8.35422 16.8214L13.2143 21.75L24.6458 10.25"),rn(s,"stroke","none"),rn(s,"stroke-width","3.5"),rn(s,"stroke-linejoin","round"),rn(s,"fill","none"),rn(o,"width","32"),rn(o,"height","32"),rn(o,"viewBox","0 0 32 32"),rn(o,"aria-hidden","true"),rn(o,"class","svelte-1y7unmi"),rn(t,"class","svelte-1y7unmi")},m(d,h){Jt(d,t,h),Vt(t,n),n.checked=e[2],Vt(t,r),Vt(t,o),Vt(o,i),Vt(o,s),Vt(t,a),Vt(t,l),Vt(l,c),u||(f=tn(n,"change",e[3]),u=!0)},p(e,[t]){4&t&&(n.checked=e[2]),2&t&&on(c,e[1])},i:bt,o:bt,d(e){e&&Kt(t),u=!1,f()}}}function Ir(e,t,n){let r,o=bt,i=()=>(o(),o=Ot(s,(e=>n(2,r=e))),s);e.$$.on_destroy.push((()=>o()));let{store:s}=t;i();let{label:a}=t;return e.$$set=e=>{"store"in e&&i(n(0,s=e.store)),"label"in e&&n(1,a=e.label)},[s,a,r,function(){r=this.checked,s.set(r)}]}"undefined"!=typeof window&&(window.__svelte||(window.__svelte={v:new Set})).v.add("4");class Lr extends er{constructor(e){super(),Xn(this,e,Ir,Or,Tt,{store:0,label:1})}}function Pr(e){let t,n,r=at(e[0].themeAnimate),o=r&&function(e){let t,n,r;return n=new Lr({props:{store:e[0].themeAnimate,label:"Animation"}}),{c(){t=Gt("section"),Gn(n.$$.fragment),rn(t,"class","svelte-20evnz")},m(e,o){Jt(e,t,o),Zn(n,t,null),r=!0},p:bt,i(e){r||(_n(n.$$.fragment,e),r=!0)},o(e){Bn(n.$$.fragment,e),r=!1},d(e){e&&Kt(t),Yn(n)}}}(e);return{c(){o&&o.c(),t=en()},m(e,r){o&&o.m(e,r),Jt(e,t,r),n=!0},p(e,[t]){r&&o.p(e,t)},i(e){n||(_n(o),n=!0)},o(e){Bn(o),n=!1},d(e){e&&Kt(t),o&&o.d(e)}}}function Ar(e){const{settingStores:t}=vn("#dmtComponentData");return[t]}function Mr(e,t){function n(){if(ut(t))for(const n of Object.keys(t))e.style.setProperty(`${n}`,t[n])}return n(),{update:e=>{t=e,n()}}}class Dr{static isComponent(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)}static isHMRProxy(e){const t=e?.constructor?.name;if("string"==typeof t&&(t.startsWith("Proxy<")||"ProxyComponent"===t))return!0;const n=e?.prototype?.constructor?.name;return"string"==typeof n&&(n.startsWith("Proxy<")||"ProxyComponent"===n)}static async outroAndDestroy(e){return null==e?Promise.resolve():new Promise((t=>{e?.$$?.fragment&&e?.$$?.fragment?.o?(Un(),Bn(e.$$.fragment,0,0,(()=>{e?.$destroy?.(),t()})),jn()):(e?.$destroy?.(),t())}))}}Object.seal(Dr);function Nr(e,t){return e}Object.seal(class{static isConfig(e,{raiseException:t=!1}={}){if(!ut(e)){if(t)throw new TypeError("TJSSvelteConfigUtil.isConfig error: 'config' is not an object.");return!1}if(!Dr.isComponent(e.class)){if(t)throw new TypeError("TJSSvelteConfigUtil.isConfig error: 'config.class' is not a Svelte component constructor.");return!1}return!0}static parseConfig(e,t=void 0){if(!ut(e))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'config' is not an object:\n${JSON.stringify(e)}.`);if(!Dr.isComponent(e.class))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component constructor for config:\n${JSON.stringify(e)}.`);if(void 0!==e.hydrate&&"boolean"!=typeof e.hydrate)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'hydrate' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.intro&&"boolean"!=typeof e.intro)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'intro' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.target&&"string"!=typeof e.target&&!dt.isElement(e.target)&&!dt.isShadowRoot(e.target)&&!dt.isDocumentFragment(e.target))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'target' is not a Element, ShadowRoot, or DocumentFragment for config:\n${JSON.stringify(e)}.`);if(void 0!==e.anchor&&"string"!=typeof e.anchor&&!dt.isElement(e.anchor)&&!dt.isShadowRoot(e.anchor)&&!dt.isDocumentFragment(e.anchor))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'anchor' is not a string, Element for config:\n${JSON.stringify(e)}.`);if(void 0!==e.context&&"function"!=typeof e.context&&!dt.isMap(e.context)&&!ut(e.context))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'context' is not a Map, function or object for config:\n${JSON.stringify(e)}.`);if(void 0!==e.selectorTarget&&"string"!=typeof e.selectorTarget)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'selectorTarget' is not a string for config:\n${JSON.stringify(e)}.`);if(void 0!==e.options&&!ut(e.options))throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options' is not an object for config:\n${JSON.stringify(e)}.`);if(ut(e.options)){if(void 0!==e.options.injectApp&&"boolean"!=typeof e.options.injectApp)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options.injectApp' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.options.injectEventbus&&"boolean"!=typeof e.options.injectEventbus)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'options.injectEventbus' is not a boolean for config:\n${JSON.stringify(e)}.`);if(void 0!==e.options.selectorElement&&"string"!=typeof e.options.selectorElement)throw new TypeError(`TJSSvelteConfigUtil.parseConfig - 'selectorElement' is not a string for config:\n${JSON.stringify(e)}.`)}const n={...e};delete n.options;let r={};if("function"==typeof n.context){const o=n.context;delete n.context;const i=o.call(t);if(!ut(i))throw new Error(`TJSSvelteConfigUtil.parseConfig - 'context' is a function that did not return an object for config:\n${JSON.stringify(e)}`);r={...i}}else dt.isMap(n.context)?(r=Object.fromEntries(n.context),delete n.context):ut(n.context)&&(r=n.context,delete n.context);if(n.props=this.#G(n.props,t,e),Array.isArray(n.children)){const o=[];for(let r=0;r0&&(r.children=o),delete n.children}else if(ut(n.children)){if(!Dr.isComponent(n.children.class))throw new Error(`TJSSvelteConfigUtil.parseConfig - 'class' is not a Svelte component for children object for config:\n${JSON.stringify(e)}`);n.children.props=this.#G(n.children.props,t,e),r.children=[n.children],delete n.children}return dt.isMap(n.context)||(n.context=new Map),n.context.set("#external",r),n}static#G(e,t,n){if("function"==typeof e){const r=e.call(t);if(ut(r))return r;throw new Error(`TJSSvelteConfigUtil.parseConfig - 'props' is a function that did not return an object for config:\n${JSON.stringify(n)}`)}if(ut(e))return e;if(void 0!==e)throw new Error(`TJSSvelteConfigUtil.parseConfig - 'props' is not a function or an object for config:\n${JSON.stringify(n)}`);return{}}});const Rr=e=>({}),Fr=e=>({}),Ur=e=>({}),jr=e=>({});function _r(e){let t;return{c(){t=Gt("div"),rn(t,"class","tjs-folder-focus-indicator svelte-1kxmj7q")},m(e,n){Jt(e,t,n)},d(e){e&&Kt(t)}}}function Br(e){let t,n,r=Nr(e[3])+"";return{c(){t=Gt("div"),n=Yt(r),rn(t,"class","label svelte-1kxmj7q")},m(r,o){Jt(r,t,o),Vt(t,n),e[37](t)},p(e,t){8&t[0]&&r!==(r=Nr(e[3])+"")&&on(n,r)},i:bt,o:bt,d(n){n&&Kt(t),e[37](null)}}}function Qr(e){let t,n,r;const o=[ut(e[6]?.slotLabel?.props)?e[6].slotLabel.props:{}];var i=e[6].slotLabel.class;function s(e,t){let n={};for(let e=0;e{Yn(e,1)})),jn()}i?(t=cn(i,s(e,r)),Gn(t.$$.fragment),_n(t.$$.fragment,1),Zn(t,n.parentNode,n)):t=null}else if(i){const n=64&r[0]?Jn(o,[Kn(ut(e[6]?.slotLabel?.props)?e[6].slotLabel.props:{})]):{};t.$set(n)}},i(e){r||(t&&_n(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Kt(n),t&&Yn(t,e)}}}function zr(e){let t,n,r;const o=[ut(e[6]?.slotSummaryEnd?.props)?e[6].slotSummaryEnd.props:{}];var i=e[6].slotSummaryEnd.class;function s(e,t){let n={};for(let e=0;e{Yn(e,1)})),jn()}i?(t=cn(i,s(e,r)),Gn(t.$$.fragment),_n(t.$$.fragment,1),Zn(t,n.parentNode,n)):t=null}else if(i){const n=64&r[0]?Jn(o,[Kn(ut(e[6]?.slotSummaryEnd?.props)?e[6].slotSummaryEnd.props:{})]):{};t.$set(n)}},i(e){r||(t&&_n(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Kt(n),t&&Yn(t,e)}}}function Hr(e){let t,n,r;const o=[ut(e[6]?.slotDefault?.props)?e[6].slotDefault.props:{}];var i=e[6].slotDefault.class;function s(e,t){let n={};for(let e=0;e{Yn(e,1)})),jn()}i?(t=cn(i,s(e,r)),Gn(t.$$.fragment),_n(t.$$.fragment,1),Zn(t,n.parentNode,n)):t=null}else if(i){const n=64&r[0]?Jn(o,[Kn(ut(e[6]?.slotDefault?.props)?e[6].slotDefault.props:{})]):{};t.$set(n)}},i(e){r||(t&&_n(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Kt(n),t&&Yn(t,e)}}}function Vr(e){let t,n,r,o,i,s,a,l,c,u,f,d,h,p,g,m,y=e[9].focusIndicator&&_r();const b=e[28].label,v=Pt(b,e,e[27],jr),w=v||function(e){let t,n,r,o,i;const s=[Qr,Br],a=[];function l(e,n){return 64&n[0]&&(t=null),null==t&&(t=!!Dr.isComponent(e[6]?.slotLabel?.class)),t?0:1}return n=l(e,[-1,-1]),r=a[n]=s[n](e),{c(){r.c(),o=en()},m(e,t){a[n].m(e,t),Jt(e,o,t),i=!0},p(e,t){let i=n;n=l(e,t),n===i?a[n].p(e,t):(Un(),Bn(a[i],1,1,(()=>{a[i]=null})),jn(),r=a[n],r?r.p(e,t):(r=a[n]=s[n](e),r.c()),_n(r,1),r.m(o.parentNode,o))},i(e){i||(_n(r),i=!0)},o(e){Bn(r),i=!1},d(e){e&&Kt(o),a[n].d(e)}}}(e),x=e[28]["summary-end"],S=Pt(x,e,e[27],Fr),E=S||function(e){let t,n,r=Dr.isComponent(e[6]?.slotSummaryEnd?.class),o=r&&zr(e);return{c(){o&&o.c(),t=en()},m(e,r){o&&o.m(e,r),Jt(e,t,r),n=!0},p(e,n){64&n[0]&&(r=Dr.isComponent(e[6]?.slotSummaryEnd?.class)),r?o?(o.p(e,n),64&n[0]&&_n(o,1)):(o=zr(e),o.c(),_n(o,1),o.m(t.parentNode,t)):o&&(Un(),Bn(o,1,1,(()=>{o=null})),jn())},i(e){n||(_n(o),n=!0)},o(e){Bn(o),n=!1},d(e){e&&Kt(t),o&&o.d(e)}}}(e),$=e[28].default,T=Pt($,e,e[27],null),k=T||function(e){let t,n,r=Dr.isComponent(e[6]?.slotDefault?.class),o=r&&Hr(e);return{c(){o&&o.c(),t=en()},m(e,r){o&&o.m(e,r),Jt(e,t,r),n=!0},p(e,n){64&n[0]&&(r=Dr.isComponent(e[6]?.slotDefault?.class)),r?o?(o.p(e,n),64&n[0]&&_n(o,1)):(o=Hr(e),o.c(),_n(o,1),o.m(t.parentNode,t)):o&&(Un(),Bn(o,1,1,(()=>{o=null})),jn())},i(e){n||(_n(o),n=!0)},o(e){Bn(o),n=!1},d(e){e&&Kt(t),o&&o.d(e)}}}(e);return{c(){t=Gt("details"),n=Gt("summary"),r=Zt("svg"),o=Zt("path"),i=Xt(),y&&y.c(),s=Xt(),w&&w.c(),a=Xt(),E&&E.c(),c=Xt(),u=Gt("div"),k&&k.c(),rn(o,"fill","currentColor"),rn(o,"stroke","currentColor"),an(o,"stroke-linejoin","round"),an(o,"stroke-width","3"),rn(o,"d","M5,8L19,8L12,15Z"),rn(r,"viewBox","0 0 24 24"),rn(r,"class","svelte-1kxmj7q"),ln(r,"focus-chevron",e[9].focusChevron),rn(n,"role","button"),rn(n,"tabindex",l=e[1]?0:-1),rn(n,"class","svelte-1kxmj7q"),ln(n,"disabled",!e[1]),ln(n,"default-cursor",e[9].chevronOnly),ln(n,"remove-focus-visible",e[9].focusIndicator||e[9].focusChevron),rn(u,"class","contents svelte-1kxmj7q"),rn(u,"aria-hidden",f=!e[13]),ln(u,"hidden",!e[13]),rn(t,"class","tjs-svg-folder svelte-1kxmj7q"),rn(t,"data-id",e[2]),rn(t,"data-label",e[3]),rn(t,"data-closing","false")},m(l,f){Jt(l,t,f),Vt(t,n),Vt(n,r),Vt(r,o),e[36](r),Vt(n,i),y&&y.m(n,null),Vt(n,s),w&&w.m(n,null),Vt(n,a),E&&E.m(n,null),e[38](n),Vt(t,c),Vt(t,u),k&&k.m(u,null),e[39](t),p=!0,g||(m=[tn(n,"click",e[14]),tn(n,"contextmenu",e[15]),tn(n,"keydown",e[16],!0),tn(n,"keyup",e[17],!0),tn(t,"close",e[18]),tn(t,"open",e[19]),tn(t,"toggle",e[40]),tn(t,"click",e[29]),tn(t,"keydown",e[30]),tn(t,"keyup",e[31]),tn(t,"open",e[32]),tn(t,"close",e[33]),tn(t,"openAny",e[34]),tn(t,"closeAny",e[35]),Ut(d=or.call(null,t,{store:e[4],animate:e[0],clickActive:!1})),Ut(h=Mr.call(null,t,e[5]))],g=!0)},p(e,o){(!p||512&o[0])&&ln(r,"focus-chevron",e[9].focusChevron),e[9].focusIndicator?y||(y=_r(),y.c(),y.m(n,s)):y&&(y.d(1),y=null),v?v.p&&(!p||134217728&o[0])&&Dt(v,b,e,e[27],p?Mt(b,e[27],o,Ur):Nt(e[27]),jr):w&&w.p&&(!p||1096&o[0])&&w.p(e,p?o:[-1,-1]),S?S.p&&(!p||134217728&o[0])&&Dt(S,x,e,e[27],p?Mt(x,e[27],o,Rr):Nt(e[27]),Fr):E&&E.p&&(!p||64&o[0])&&E.p(e,p?o:[-1,-1]),(!p||2&o[0]&&l!==(l=e[1]?0:-1))&&rn(n,"tabindex",l),(!p||2&o[0])&&ln(n,"disabled",!e[1]),(!p||512&o[0])&&ln(n,"default-cursor",e[9].chevronOnly),(!p||512&o[0])&&ln(n,"remove-focus-visible",e[9].focusIndicator||e[9].focusChevron),T?T.p&&(!p||134217728&o[0])&&Dt(T,$,e,e[27],p?Mt($,e[27],o,null):Nt(e[27]),null):k&&k.p&&(!p||64&o[0])&&k.p(e,p?o:[-1,-1]),(!p||8192&o[0]&&f!==(f=!e[13]))&&rn(u,"aria-hidden",f),(!p||8192&o[0])&&ln(u,"hidden",!e[13]),(!p||4&o[0])&&rn(t,"data-id",e[2]),(!p||8&o[0])&&rn(t,"data-label",e[3]),d&&$t(d.update)&&17&o[0]&&d.update.call(null,{store:e[4],animate:e[0],clickActive:!1}),h&&$t(h.update)&&32&o[0]&&h.update.call(null,e[5])},i(e){p||(_n(w,e),_n(E,e),_n(k,e),p=!0)},o(e){Bn(w,e),Bn(E,e),Bn(k,e),p=!1},d(n){n&&Kt(t),e[36](null),y&&y.d(),w&&w.d(n),E&&E.d(n),e[38](null),k&&k.d(n),e[39](null),g=!1,Et(m)}}}function qr(e,t,n){let r,o=bt,i=()=>(o(),o=Ot(g,(e=>n(8,r=e))),g);e.$$.on_destroy.push((()=>o()));let{$$slots:s={},$$scope:a}=t,{folder:l}=t,{animate:c}=t,{enabled:u}=t,{id:f}=t,{label:d}=t,{keyCode:h}=t,{options:p}=t,{store:g}=t;i();let{styles:m}=t,{onClose:y}=t,{onOpen:b}=t,{onContextMenu:v}=t;const w={chevronOnly:!1,focusChevron:!1,focusIndicator:!1};let x,S,E,$,T,k,C=r;var O;function I(e,t=!1){return new CustomEvent(e,{detail:{element:x,folder:l,id:f,label:d,store:g},bubbles:t})}function L(e,t=!1){const n=e.target,o=n===$||$.contains(n);if(n===E||n===S||o){if(!t&&w.chevronOnly&&!o)return e.preventDefault(),void e.stopPropagation();Ft(g,r=!r,r),r&&"function"==typeof b?b({event:e,element:x,folder:l,id:f,label:d,store:g}):r||"function"!=typeof y||y({event:e,element:x,folder:l,id:f,label:d,store:g})}e.preventDefault(),e.stopPropagation()}O=()=>T(),mn().$$.on_destroy.push(O);return e.$$set=e=>{"folder"in e&&n(6,l=e.folder),"animate"in e&&n(0,c=e.animate),"enabled"in e&&n(1,u=e.enabled),"id"in e&&n(2,f=e.id),"label"in e&&n(3,d=e.label),"keyCode"in e&&n(20,h=e.keyCode),"options"in e&&n(21,p=e.options),"store"in e&&i(n(4,g=e.store)),"styles"in e&&n(5,m=e.styles),"onClose"in e&&n(22,y=e.onClose),"onOpen"in e&&n(23,b=e.onOpen),"onContextMenu"in e&&n(24,v=e.onContextMenu),"$$scope"in e&&n(27,a=e.$$scope)},e.$$.update=()=>{65&e.$$.dirty[0]&&n(0,c=ut(l)&&"boolean"==typeof l.animate?l.animate:"boolean"!=typeof c||c),66&e.$$.dirty[0]&&n(1,u=ut(l)&&"boolean"==typeof l.enabled?l.enabled:"boolean"!=typeof u||u),68&e.$$.dirty[0]&&n(2,f=ut(l)&&"string"==typeof l.id?l.id:"string"==typeof f?f:void 0),72&e.$$.dirty[0]&&n(3,d=ut(l)&&"string"==typeof l.label?l.label:"string"==typeof d?d:""),1048640&e.$$.dirty[0]&&n(20,h=ut(l)&&"string"==typeof l.keyCode?l.keyCode:"string"==typeof h?h:"Enter"),2097216&e.$$.dirty[0]&&(n(21,p=ut(l)&&ut(l.options)?l.options:ut(p)?p:{}),"boolean"==typeof p?.chevronOnly&&n(9,w.chevronOnly=p.chevronOnly,w),"boolean"==typeof p?.focusChevron&&n(9,w.focusChevron=p.focusChevron,w),"boolean"==typeof p?.focusIndicator&&n(9,w.focusIndicator=p.focusIndicator,w)),33554640&e.$$.dirty[0]&&(i(n(4,g=ut(l)&&st(l.store)?l.store:st(g)?g:rr(!1))),"function"==typeof T&&T(),n(25,T=function(e,t){let n=!1;return e.subscribe((e=>{n?t(e):n=!0}))}(g,(e=>{x&&(x.dispatchEvent(I(e?"open":"close")),x.dispatchEvent(I(e?"openAny":"closeAny",!0)))})))),96&e.$$.dirty[0]&&n(5,m=ut(l)&&ut(l.styles)?l.styles:ut(m)?m:void 0),4194368&e.$$.dirty[0]&&n(22,y=ut(l)&&"function"==typeof l.onClose?l.onClose:"function"==typeof y?y:void 0),8388672&e.$$.dirty[0]&&n(23,b=ut(l)&&"function"==typeof l.onOpen?l.onOpen:"function"==typeof b?b:void 0),16777280&e.$$.dirty[0]&&n(24,v=ut(l)&&"function"==typeof l.onContextMenu?l.onContextMenu:"function"==typeof v?v:void 0),67109120&e.$$.dirty[0]&&(r?(clearTimeout(k),n(13,C=!0)):n(26,k=setTimeout((()=>n(13,C=!1)),500)))},[c,u,f,d,g,m,l,x,r,w,S,E,$,C,function(e){if(u)return E!==dt.getActiveElement(e)||-1!==e?.pointerId&&6!==e?.mozInputSource?void L(e):(e.preventDefault(),void e.stopPropagation())},function(e){u&&"function"==typeof v&&v({event:e,element:x,folder:l,id:f,label:d,store:g})},function(e){u&&E===dt.getActiveElement(e)&&e.code===h&&(e.preventDefault(),e.stopPropagation())},function(e){u&&E===dt.getActiveElement(e)&&e.code===h&&(L(e,!0),e.preventDefault(),e.stopPropagation())},function(e){e.preventDefault(),e.stopPropagation(),g.set(!1)},function(e){e.preventDefault(),e.stopPropagation(),g.set(!0)},h,p,y,b,v,T,k,a,s,function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},function(e){Sn[e?"unshift":"push"]((()=>{$=e,n(12,$)}))},function(e){Sn[e?"unshift":"push"]((()=>{S=e,n(10,S)}))},function(e){Sn[e?"unshift":"push"]((()=>{E=e,n(11,E)}))},function(e){Sn[e?"unshift":"push"]((()=>{x=e,n(7,x)}))},()=>n(7,x.open=r,x)]}class Wr extends er{constructor(e){super(),Xn(this,e,qr,Vr,Tt,{folder:6,animate:0,enabled:1,id:2,label:3,keyCode:20,options:21,store:4,styles:5,onClose:22,onOpen:23,onContextMenu:24},null,[-1,-1])}}function Jr(e){let t,n,r=e[0].text+"";return{c(){t=Gt("span"),n=Yt(r),rn(t,"class","svelte-14yttr0"),ln(t,"indent-icon","indent-icon"===e[1]),ln(t,"indent-no-icon","indent-no-icon"===e[1])},m(e,r){Jt(e,t,r),Vt(t,n)},p(e,o){1&o&&r!==(r=e[0].text+"")&&on(n,r),2&o&&ln(t,"indent-icon","indent-icon"===e[1]),2&o&&ln(t,"indent-no-icon","indent-no-icon"===e[1])},d(e){e&&Kt(t)}}}function Kr(e){let t,n,r,o,i,s,a=e[0].text+"",l=e[5]&&function(e){let t,n;return{c(){t=Zt("svg"),n=Zt("use"),rn(n,"href",`#icon-${e[5]}`),rn(t,"class","tsd-kind-icon svelte-14yttr0"),rn(t,"viewBox","0 0 24 24")},m(e,r){Jt(e,t,r),Vt(t,n)},p:bt,d(e){e&&Kt(t)}}}(e);return{c(){t=Gt("a"),l&&l.c(),n=Xt(),r=Gt("span"),o=Yt(a),rn(r,"class","svelte-14yttr0"),rn(t,"href",e[6]),rn(t,"data-storage-key",e[2]),rn(t,"class","svelte-14yttr0"),ln(t,"current",e[3]),ln(t,"indent-icon","indent-icon"===e[1]),ln(t,"indent-no-icon","indent-no-icon"===e[1]),ln(t,"indent-none","indent-none"===e[1])},m(a,c){var u;Jt(a,t,c),l&&l.m(t,null),Vt(t,n),Vt(t,r),Vt(r,o),i||(s=tn(t,"click",nn((u=e[7],function(e){return e.preventDefault(),u.call(this,e)}))),i=!0)},p(e,n){e[5]&&l.p(e,n),1&n&&a!==(a=e[0].text+"")&&on(o,a),4&n&&rn(t,"data-storage-key",e[2]),8&n&&ln(t,"current",e[3]),2&n&&ln(t,"indent-icon","indent-icon"===e[1]),2&n&&ln(t,"indent-no-icon","indent-no-icon"===e[1]),2&n&&ln(t,"indent-none","indent-none"===e[1])},d(e){e&&Kt(t),l&&l.d(),i=!1,s()}}}function Gr(e){let t;let n=function(e){return e[6]?Kr:Jr}(e),r=n(e);return{c(){r.c(),t=en()},m(e,n){r.m(e,n),Jt(e,t,n)},p(e,[t]){r.p(e,t)},i:bt,o:bt,d(e){e&&Kt(t),r.d(e)}}}function Zr(e,t,n){let r,o,{entry:i}=t,{removeIcon:s=!1}=t,{indentIcon:a}=t,{storageKey:l=null}=t;const{basePath:c,navigation:u}=vn("#dmtComponentData"),f=u.treeState.storeCurrentPathURL;Lt(e,f,(e=>n(9,o=e)));const d=!s&&i.kind?i.kind:void 0,h=i.path?`${c}${i.path}`:void 0;return e.$$set=e=>{"entry"in e&&n(0,i=e.entry),"removeIcon"in e&&n(8,s=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=!!i.path&&i.path===o)},[i,a,l,r,f,d,h,function(){globalThis.location.href=h},s,o]}class Yr extends er{constructor(e){super(),Xn(this,e,Zr,Gr,Tt,{entry:0,removeIcon:8,indentIcon:1,storageKey:2})}}function Xr(e,t,n){const r=e.slice();return r[14]=t[n],r}function eo(e){let t,n;return t=new Yr({props:{entry:e[14],indentIcon:e[6],removeIcon:!e[2]&&2===e[14]?.kind}}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[14]),1&n&&(r.removeIcon=!e[2]&&2===e[14]?.kind),t.$set(r)},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function to(e){let t,n;return t=new ao({props:{entry:e[14],parentIcon:!e[5]}}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[14]),t.$set(r)},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function no(e,t){let n,r,o,i,s,a;const l=[to,eo],c=[];function u(e,t){return 1&t&&(r=null),null==r&&(r=!!Array.isArray(e[14].children)),r?0:1}return o=u(t,-1),i=c[o]=l[o](t),{key:e,first:null,c(){n=en(),i.c(),s=en(),this.first=n},m(e,t){Jt(e,n,t),c[o].m(e,t),Jt(e,s,t),a=!0},p(e,n){let r=o;o=u(t=e,n),o===r?c[o].p(t,n):(Un(),Bn(c[r],1,1,(()=>{c[r]=null})),jn(),i=c[o],i?i.p(t,n):(i=c[o]=l[o](t),i.c()),_n(i,1),i.m(s.parentNode,s))},i(e){a||(_n(i),a=!0)},o(e){Bn(i),a=!1},d(e){e&&(Kt(n),Kt(s)),c[o].d(e)}}}function ro(e){let t,n,r=[],o=new Map,i=Hn(e[0].children);const s=e=>e[14].path;for(let t=0;tn(1,r=e)));const c=vn("#treeState"),u=o.storageKey,f=u?c.sessionStorage.getStore(u,!1):void 0,d=!a&&(void 0===o.kind||2===o.kind),h=d?"indent-no-icon":"indent-icon",p={store:f,options:{focusChevron:!0},styles:i?{"--tjs-folder-details-margin-left":"3.5px"}:void 0};return e.$$set=e=>{"entry"in e&&n(0,o=e.entry),"parentIcon"in e&&n(10,i=e.parentIcon)},[o,r,a,l,u,d,h,p,function(e){e?.event?.altKey&&c.setChildFolderState(o,!1)},function(e){e?.event?.altKey&&c.setChildFolderState(o,!0)},i]}class ao extends er{constructor(e){super(),Xn(this,e,so,io,Tt,{entry:0,parentIcon:10})}}function lo(e,t,n){const r=e.slice();return r[8]=t[n],r}function co(e){let t,n;return t=new Yr({props:{entry:e[8],indentIcon:e[4],removeIcon:!e[2]&&2===e[8]?.kind}}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[8]),1&n&&(r.removeIcon=!e[2]&&2===e[8]?.kind),t.$set(r)},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function uo(e){let t,n;return t=new ao({props:{entry:e[8]}}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.entry=e[8]),t.$set(r)},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function fo(e,t){let n,r,o,i,s,a;const l=[uo,co],c=[];function u(e,t){return 1&t&&(r=null),null==r&&(r=!!Array.isArray(e[8].children)),r?0:1}return o=u(t,-1),i=c[o]=l[o](t),{key:e,first:null,c(){n=en(),i.c(),s=en(),this.first=n},m(e,t){Jt(e,n,t),c[o].m(e,t),Jt(e,s,t),a=!0},p(e,n){let r=o;o=u(t=e,n),o===r?c[o].p(t,n):(Un(),Bn(c[r],1,1,(()=>{c[r]=null})),jn(),i=c[o],i?i.p(t,n):(i=c[o]=l[o](t),i.c()),_n(i,1),i.m(s.parentNode,s))},i(e){a||(_n(i),a=!0)},o(e){Bn(i),a=!1},d(e){e&&(Kt(n),Kt(s)),c[o].d(e)}}}function ho(e){let t,n,r,o,i=[],s=new Map,a=Hn(e[0].elementIndex);const l=e=>e[8].path;for(let t=0;tn(5,r=e)));const c=o.hasFolders?"indent-no-icon":"indent-none";return e.$$set=e=>{"treeState"in e&&n(0,o=e.treeState)},e.$$.update=()=>{34&e.$$.dirty&&r&&hr().then((()=>{const e=l.querySelector(`a[href*="${r}"]`);e&&e.scrollIntoView({block:"center",inline:"center"})}))},[o,l,s,a,c,r,function(e){Sn[e?"unshift":"push"]((()=>{l=e,n(1,l)}))}]}class mo extends er{constructor(e){super(),Xn(this,e,go,ho,Tt,{treeState:0})}}function yo(e){let t,n,r,o;return r=new mo({props:{treeState:e[1].treeState.markdown}}),{c(){t=Gt("hr"),n=Xt(),Gn(r.$$.fragment),rn(t,"class","svelte-wwxcg7")},m(e,i){Jt(e,t,i),Jt(e,n,i),Zn(r,e,i),o=!0},p:bt,i(e){o||(_n(r.$$.fragment,e),o=!0)},o(e){Bn(r.$$.fragment,e),o=!1},d(e){e&&(Kt(t),Kt(n)),Yn(r,e)}}}function bo(e){let t,n,r=e[1].treeState.markdown.hasData&&function(e){let t,n,r;return n=new Wr({props:{folder:e[4],animate:e[0],$$slots:{default:[yo]},$$scope:{ctx:e}}}),{c(){t=Gt("section"),Gn(n.$$.fragment),rn(t,"class","dmt-document-index svelte-wwxcg7")},m(e,o){Jt(e,t,o),Zn(n,t,null),r=!0},p(e,t){const r={};1&t&&(r.animate=e[0]),512&t&&(r.$$scope={dirty:t,ctx:e}),n.$set(r)},i(e){r||(_n(n.$$.fragment,e),r=!0)},o(e){Bn(n.$$.fragment,e),r=!1},d(e){e&&Kt(t),Yn(n)}}}(e);return{c(){r&&r.c(),t=en()},m(e,o){r&&r.m(e,o),Jt(e,t,o),n=!0},p(e,[t]){e[1].treeState.markdown.hasData&&r.p(e,t)},i(e){n||(_n(r),n=!0)},o(e){Bn(r),n=!1},d(e){e&&Kt(t),r&&r.d(e)}}}function vo(e,t,n){let r,o;const{dmtSessionStorage:i,navigation:s,settingStores:a,storagePrepend:l}=vn("#dmtComponentData"),c=a.themeAnimate;Lt(e,c,(e=>n(0,o=e)));const u=i.getStore(`${l}-document-index`,!0);Lt(e,u,(e=>n(5,r=e))),"markdown"===s.treeState.activeTreeName&&Ft(u,r=!0,r);return[o,s,c,u,{store:u,label:"Document Index",options:{focusChevron:!0}}]}class wo extends er{constructor(e){super(),Xn(this,e,vo,bo,Tt,{})}}function xo(e,t,n){const r=e.slice();return r[2]=t[n],r}function So(e,t){let n,r;return{key:e,first:null,c(){n=Gt("a"),r=Gt("span"),r.textContent=`${t[2]}`,rn(n,"href",`${t[0][t[2]]}`),rn(n,"target","_blank"),rn(n,"class","svelte-ietkuq"),this.first=n},m(e,t){Jt(e,n,t),Vt(n,r)},p(e,n){t=e},d(e){e&&Kt(n)}}}function Eo(e){let t,n=e[1]&&function(e){let t,n=[],r=new Map,o=Hn(Object.keys(e[0]));const i=e=>e[0][e[2]];for(let t=0;t0]}class To extends er{constructor(e){super(),Xn(this,e,$o,Eo,Tt,{})}}function ko(e){const t=e*e;return e<4/11?7.5625*t:e<8/11?9.075*t-9.9*e+3.4:e<.9?4356/361*t-35442/1805*e+16061/1805:10.8*e*e-20.52*e+10.72}function Co(e){const t=e-1;return t*t*t+1}function Oo(e){return e*e*e*e*e}const Io=Object.freeze({__proto__:null,backIn:function(e){const t=1.70158;return e*e*((t+1)*e-t)},backInOut:function(e){const t=2.5949095;return(e*=2)<1?e*e*((t+1)*e-t)*.5:.5*((e-=2)*e*((t+1)*e+t)+2)},backOut:function(e){const t=1.70158;return--e*e*((t+1)*e+t)+1},bounceIn:function(e){return 1-ko(1-e)},bounceInOut:function(e){return e<.5?.5*(1-ko(1-2*e)):.5*ko(2*e-1)+.5},bounceOut:ko,circIn:function(e){return 1-Math.sqrt(1-e*e)},circInOut:function(e){return(e*=2)<1?-.5*(Math.sqrt(1-e*e)-1):.5*(Math.sqrt(1-(e-=2)*e)+1)},circOut:function(e){return Math.sqrt(1- --e*e)},cubicIn:function(e){return e*e*e},cubicInOut:function(e){return e<.5?4*e*e*e:.5*Math.pow(2*e-2,3)+1},cubicOut:Co,elasticIn:function(e){return Math.sin(13*e*Math.PI/2)*Math.pow(2,10*(e-1))},elasticInOut:function(e){return e<.5?.5*Math.sin(13*Math.PI/2*2*e)*Math.pow(2,10*(2*e-1)):.5*Math.sin(-13*Math.PI/2*(2*e-1+1))*Math.pow(2,-10*(2*e-1))+1},elasticOut:function(e){return Math.sin(-13*(e+1)*Math.PI/2)*Math.pow(2,-10*e)+1},expoIn:function(e){return 0===e?e:Math.pow(2,10*(e-1))},expoInOut:function(e){return 0===e||1===e?e:e<.5?.5*Math.pow(2,20*e-10):-.5*Math.pow(2,10-20*e)+1},expoOut:function(e){return 1===e?e:1-Math.pow(2,-10*e)},linear:vt,quadIn:function(e){return e*e},quadInOut:function(e){return(e/=.5)<1?.5*e*e:-.5*(--e*(e-2)-1)},quadOut:function(e){return-e*(e-2)},quartIn:function(e){return Math.pow(e,4)},quartInOut:function(e){return e<.5?8*Math.pow(e,4):-8*Math.pow(e-1,4)+1},quartOut:function(e){return Math.pow(e-1,3)*(1-e)+1},quintIn:Oo,quintInOut:function(e){return(e*=2)<1?.5*e*e*e*e*e:.5*((e-=2)*e*e*e*e+2)},quintOut:function(e){return--e*e*e*e*e+1},sineIn:function(e){const t=Math.cos(e*Math.PI*.5);return Math.abs(t)<1e-14?1:1-t},sineInOut:function(e){return-.5*(Math.cos(Math.PI*e)-1)},sineOut:function(e){return Math.sin(e*Math.PI/2)}});function Lo(e,t){if("function"==typeof e)return e;const n=Io[e];return n||Io.linear}function Po(e,t){const n=Lo(t.easingFade??t.easing),r=Lo(t.easingSlide??t.easing),o=function(e,{delay:t=0,duration:n=400,easing:r=vt}={}){const o=+getComputedStyle(e).opacity;return{delay:t,duration:n,easing:r,css:e=>"opacity: "+e*o}}(e),i=function(e,{delay:t=0,duration:n=400,easing:r=Co,axis:o="y"}={}){const i=getComputedStyle(e),s=+i.opacity,a="y"===o?"height":"width",l=parseFloat(i[a]),c="y"===o?["top","bottom"]:["left","right"],u=c.map((e=>`${e[0].toUpperCase()}${e.slice(1)}`)),f=parseFloat(i[`padding${u[0]}`]),d=parseFloat(i[`padding${u[1]}`]),h=parseFloat(i[`margin${u[0]}`]),p=parseFloat(i[`margin${u[1]}`]),g=parseFloat(i[`border${u[0]}Width`]),m=parseFloat(i[`border${u[1]}Width`]);return{delay:t,duration:n,easing:r,css:e=>`overflow: hidden;opacity: ${Math.min(20*e,1)*s};${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:vt,css:e=>{const t=n(e),s=r(e);return`${i.css(s,1-s)}; ${o.css(t,1-t)}`}}}function Ao(e,t,n){const r=e.slice();return r[13]=t[n],r}function Mo(e,t){let n,r,o,i,s,a,l=t[13].key+"";return{key:e,first:null,c(){n=Gt("span"),r=Zt("svg"),o=Zt("use"),i=Xt(),s=Yt(l),a=Xt(),rn(o,"href",`#icon-${t[13].value}`),rn(r,"class","tsd-kind-icon svelte-1uxeem0"),rn(r,"viewBox","0 0 24 24"),rn(n,"class","svelte-1uxeem0"),this.first=n},m(e,t){Jt(e,n,t),Vt(n,r),Vt(r,o),Vt(n,i),Vt(n,s),Vt(n,a)},p(e,n){t=e},d(e){e&&Kt(n)}}}function Do(e){let t,n,r,o,i,s,a,l,c,u,f,d,h,p,g,m,y,b,v,w,x,S,E,$,T,k=[],C=new Map,O=Hn(e[7]);const I=e=>e[13].value;for(let t=0;tAlt + DOpen / focus "Document Index"',rn(e,"class","svelte-1uxeem0")},m(t,n){Jt(t,e,n)},d(t){t&&Kt(e)}}}(),P=e[3]&&function(){let e;return{c(){e=Gt("span"),e.innerHTML='Alt + ESource (Nav) open / close all',rn(e,"class","svelte-1uxeem0")},m(t,n){Jt(t,e,n)},d(t){t&&Kt(e)}}}(),A=e[0].modules&&function(e){let t,n,r,o,i;return{c(){t=Gt("span"),n=Gt("i"),n.textContent="Alt + M",r=Yt("Go to "),o=Yt(e[6]),i=Yt(" page"),rn(n,"class","key svelte-1uxeem0"),rn(t,"class","svelte-1uxeem0")},m(e,s){Jt(e,t,s),Vt(t,n),Vt(t,r),Vt(t,o),Vt(t,i)},p:bt,d(e){e&&Kt(t)}}}(e),M=e[0].hierarchy&&function(){let e;return{c(){e=Gt("span"),e.innerHTML='Alt + YGo to class hierarchy page',rn(e,"class","svelte-1uxeem0")},m(t,n){Jt(t,e,n)},d(t){t&&Kt(e)}}}(),D=e[1]&&function(){let e;return{c(){e=Gt("span"),e.innerHTML='AltPress when opening / closing folders to open / close all child folders.',rn(e,"class","svelte-1uxeem0")},m(t,n){Jt(t,e,n)},d(t){t&&Kt(e)}}}();return{c(){t=Gt("div"),n=Gt("span"),n.textContent="Reflection Icon Reference:",r=Xt(),o=Gt("section");for(let e=0;eAlt + CFocus main content',c=Xt(),L&&L.c(),u=Xt(),P&&P.c(),f=Xt(),d=Gt("span"),d.innerHTML='Alt + HOpen / close help',h=Xt(),p=Gt("span"),p.innerHTML='Alt + IGo to home / index page',g=Xt(),m=Gt("span"),m.innerHTML='Alt + NSource (Nav) focus selected',y=Xt(),A&&A.c(),b=Xt(),v=Gt("span"),v.innerHTML='Alt + OOpen / focus "On This Page"',w=Xt(),x=Gt("span"),x.innerHTML='Alt + SActivate search',S=Xt(),M&&M.c(),E=Xt(),D&&D.c(),rn(n,"class","title svelte-1uxeem0"),rn(o,"class","reflection-kinds svelte-1uxeem0"),rn(s,"class","title svelte-1uxeem0"),rn(l,"class","svelte-1uxeem0"),rn(d,"class","svelte-1uxeem0"),rn(p,"class","svelte-1uxeem0"),rn(m,"class","svelte-1uxeem0"),rn(v,"class","svelte-1uxeem0"),rn(x,"class","svelte-1uxeem0"),rn(t,"class","svelte-1uxeem0")},m(e,$){Jt(e,t,$),Vt(t,n),Vt(t,r),Vt(t,o);for(let e=0;e{T&&($||($=zn(t,e[5],{duration:100},!0)),$.run(1))})),T=!0)},o(n){n&&($||($=zn(t,e[5],{duration:100},!1)),$.run(0)),T=!1},d(e){e&&Kt(t);for(let e=0;en(8,r=e)));const h=r?Po:()=>{},p=o?"package":"module",g=[];for(const[e,t]of Object.entries(a))"number"==typeof t&&g.push({key:e,value:t});return g.sort(((e,t)=>e.key.localeCompare(t.key))),[s,c,u,f,d,h,p,g]}class Ro extends er{constructor(e){super(),Xn(this,e,No,Do,Tt,{})}}function Fo(e){let t,n;return t=new Ro({}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function Uo(e){let t,n,r,o,i,s,a,l,c,u,f,d,h,p=e[5]>0&&function(e){let t,n,r,o,i,s,a,l,c;return{c(){t=Zt("svg"),n=Zt("symbol"),r=Zt("path"),o=Xt(),i=Gt("button"),i.innerHTML='',s=Xt(),a=Gt("button"),a.innerHTML='',rn(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"),rn(n,"id","dmt-double-icon-arrow"),rn(n,"viewBox","0 0 1024 1024"),an(t,"display","none"),rn(t,"class","svelte-1xrvgp2"),rn(i,"title","Open All"),rn(i,"class","svelte-1xrvgp2"),rn(a,"title","Close All"),rn(a,"class","svelte-1xrvgp2")},m(u,f){Jt(u,t,f),Vt(t,n),Vt(n,r),Jt(u,o,f),Jt(u,i,f),Jt(u,s,f),Jt(u,a,f),l||(c=[tn(i,"click",e[10]),tn(i,"keydown",jo),tn(i,"pointerdown",nn(e[9])),tn(a,"click",e[11]),tn(a,"keydown",jo),tn(a,"pointerdown",nn(e[8]))],l=!0)},p:bt,d(e){e&&(Kt(t),Kt(o),Kt(i),Kt(s),Kt(a)),l=!1,Et(c)}}}(e),g=e[4].hierarchy&&function(e){let t,n,r;return{c(){t=Gt("button"),t.innerHTML='',rn(t,"title","Class Hierarchy"),rn(t,"class","svelte-1xrvgp2")},m(o,i){Jt(o,t,i),n||(r=[tn(t,"click",e[12]),tn(t,"keydown",jo)],n=!0)},p:bt,d(e){e&&Kt(t),n=!1,Et(r)}}}(e),m=e[4].modules&&function(e){let t,n,r,o,i,s,a;return{c(){t=Gt("button"),n=Zt("svg"),r=Zt("rect"),o=Zt("rect"),i=Zt("rect"),rn(r,"x","10"),rn(r,"y","0"),rn(r,"width","12"),rn(r,"height","6"),rn(o,"x","6"),rn(o,"y","13"),rn(o,"width","20"),rn(o,"height","6"),rn(i,"x","0"),rn(i,"y","26"),rn(i,"width","32"),rn(i,"height","6"),rn(n,"width","32"),rn(n,"height","32"),rn(n,"viewBox","0 0 32 32"),rn(n,"xmlns","http://www.w3.org/2000/svg"),rn(n,"class","svelte-1xrvgp2"),rn(t,"title",e[7]),rn(t,"class","svelte-1xrvgp2")},m(l,c){Jt(l,t,c),Vt(t,n),Vt(n,r),Vt(n,o),Vt(n,i),s||(a=[tn(t,"click",e[13]),tn(t,"keydown",jo)],s=!0)},p:bt,d(e){e&&Kt(t),s=!1,Et(a)}}}(e),y=e[0]&&Fo();return{c(){t=Gt("section"),p&&p.c(),n=Xt(),g&&g.c(),r=Xt(),m&&m.c(),o=Xt(),i=Gt("button"),s=Zt("svg"),a=Zt("g"),l=Zt("path"),c=Zt("path"),u=Xt(),y&&y.c(),rn(l,"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"),rn(c,"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"),rn(s,"viewBox","0 0 973.1 973.1"),rn(s,"class","svelte-1xrvgp2"),rn(i,"title",e[1]),rn(i,"class","svelte-1xrvgp2"),rn(t,"class","svelte-1xrvgp2")},m(b,v){Jt(b,t,v),p&&p.m(t,null),Vt(t,n),g&&g.m(t,null),Vt(t,r),m&&m.m(t,null),Vt(t,o),Vt(t,i),Vt(i,s),Vt(s,a),Vt(a,l),Vt(a,c),Vt(t,u),y&&y.m(t,null),f=!0,d||(h=[tn(i,"click",e[14]),tn(i,"keydown",jo)],d=!0)},p(e,[n]){e[5]>0&&p.p(e,n),e[4].hierarchy&&g.p(e,n),e[4].modules&&m.p(e,n),(!f||2&n)&&rn(i,"title",e[1]),e[0]?y?1&n&&_n(y,1):(y=Fo(),y.c(),_n(y,1),y.m(t,null)):y&&(Un(),Bn(y,1,1,(()=>{y=null})),jn())},i(e){f||(_n(y),f=!0)},o(e){Bn(y),f=!1},d(e){e&&Kt(t),p&&p.d(),g&&g.d(),m&&m.d(),y&&y.d(),d=!1,Et(h)}}}function jo(e){e.repeat&&(e.stopPropagation(),e.preventDefault())}function _o(e,t,n){let r,o;const{baseURL:i,moduleIsPackage:s,navigation:a,pageIndex:l,stateStores:c}=vn("#dmtComponentData"),u=a.treeState.source.hasFolders,f=c.helpPanelVisible;Lt(e,f,(e=>n(0,o=e)));const d=s?"Package Index":"Module Index";return e.$$.update=()=>{1&e.$$.dirty&&n(1,r=o?"Close Help":"Open Help")},[o,r,i,a,l,u,f,d,function(t){wn.call(this,e,t)},function(t){wn.call(this,e,t)},()=>a.treeState.source.setFoldersAllOpen(!0),()=>a.treeState.source.setFoldersAllOpen(!1),()=>globalThis.location.href=`${i}${l.hierarchy}`,()=>globalThis.location.href=`${i}${l.modules}`,()=>Ft(f,o=!o,o)]}class Bo extends er{constructor(e){super(),Xn(this,e,_o,Uo,Tt,{})}}function Qo(e){let t,n,r,o,i;return n=new Bo({}),o=new mo({props:{treeState:e[0].treeState.source}}),{c(){t=Gt("section"),Gn(n.$$.fragment),r=Xt(),Gn(o.$$.fragment),rn(t,"class","source-index svelte-13h1skr")},m(e,s){Jt(e,t,s),Zn(n,t,null),Vt(t,r),Zn(o,t,null),i=!0},p:bt,i(e){i||(_n(n.$$.fragment,e),_n(o.$$.fragment,e),i=!0)},o(e){Bn(n.$$.fragment,e),Bn(o.$$.fragment,e),i=!1},d(e){e&&Kt(t),Yn(n),Yn(o)}}}function zo(e){const{navigation:t}=vn("#dmtComponentData");return[t]}class Ho extends er{constructor(e){super(),Xn(this,e,zo,Qo,Tt,{})}}function Vo(e){let t,n,r,o,i,s;return t=new To({}),r=new wo({}),i=new Ho({}),{c(){Gn(t.$$.fragment),n=Xt(),Gn(r.$$.fragment),o=Xt(),Gn(i.$$.fragment)},m(e,a){Zn(t,e,a),Jt(e,n,a),Zn(r,e,a),Jt(e,o,a),Zn(i,e,a),s=!0},p:bt,i(e){s||(_n(t.$$.fragment,e),_n(r.$$.fragment,e),_n(i.$$.fragment,e),s=!0)},o(e){Bn(t.$$.fragment,e),Bn(r.$$.fragment,e),Bn(i.$$.fragment,e),s=!1},d(e){e&&(Kt(n),Kt(o)),Yn(t,e),Yn(r,e),Yn(i,e)}}}function qo(e){let t,n,r;return{c(){t=Gt("button"),t.innerHTML='',rn(t,"class","svelte-10arjs8")},m(o,i){Jt(o,t,i),n||(r=[tn(t,"click",e[3]),tn(t,"pointerdown",nn(e[2]))],n=!0)},p:bt,i:bt,o:bt,d(e){e&&Kt(t),n=!1,Et(r)}}}function Wo(e,t,n){let r;const{stateStores:o}=vn("#dmtComponentData"),i=o.mainSearchVisible;Lt(e,i,(e=>n(0,r=e)));return[r,i,function(t){wn.call(this,e,t)},()=>Ft(i,r=!r,r)]}class Jo extends er{constructor(e){super(),Xn(this,e,Wo,qo,Tt,{})}}function Ko(e,t,n){const r=e.slice();return r[14]=t[n],r}function Go(e){let t,n,r;return{c(){t=Zt("svg"),n=Zt("use"),rn(n,"href",r=`#icon-${e[14].kind}`),rn(t,"class","tsd-kind-icon"),rn(t,"viewBox","0 0 24 24")},m(e,r){Jt(e,t,r),Vt(t,n)},p(e,t){2&t&&r!==(r=`#icon-${e[14].kind}`)&&rn(n,"href",r)},d(e){e&&Kt(t)}}}function Zo(e,t){let n,r,o,i,s,a,l,c=t[14].name+"",u=t[14].kind&&Go(t);function f(){return t[8](t[14])}return{key:e,first:null,c(){n=Gt("li"),u&&u.c(),r=Xt(),o=Gt("span"),i=Xt(),rn(o,"class","parent"),rn(n,"class",s=Rt(t[14].classes)+" svelte-5rxzhp"),rn(n,"role","menuitem"),ln(n,"selected",t[14].id===t[2]),this.first=n},m(e,t){Jt(e,n,t),u&&u.m(n,null),Vt(n,r),Vt(n,o),o.innerHTML=c,Vt(n,i),a||(l=tn(n,"click",f),a=!0)},p(e,i){(t=e)[14].kind?u?u.p(t,i):(u=Go(t),u.c(),u.m(n,r)):u&&(u.d(1),u=null),2&i&&c!==(c=t[14].name+"")&&(o.innerHTML=c),2&i&&s!==(s=Rt(t[14].classes)+" svelte-5rxzhp")&&rn(n,"class",s),6&i&&ln(n,"selected",t[14].id===t[2])},d(e){e&&Kt(n),u&&u.d(),a=!1,l()}}}function Yo(e){let t,n,r,o=[],i=new Map,s=Hn(e[1]);const a=e=>e[14].id;for(let t=0;t{r&&(n||(n=zn(t,e[6],{duration:100},!0)),n.run(1))})),r=!0)},o(o){n||(n=zn(t,e[6],{duration:100},!1)),n.run(0),r=!1},d(r){r&&Kt(t);for(let e=0;en(10,r=e)));const f=l.themeAnimate;Lt(e,f,(e=>n(11,o=e)));const d=vn("#storeCurrentId");Lt(e,d,(e=>n(2,i=e)));const h=o?Po:()=>{};function p(e){Ft(u,r=!1,r),globalThis.location.href=e}return e.$$set=e=>{"results"in e&&n(1,s=e.results),"resultsEl"in e&&n(0,a=e.resultsEl)},[a,s,i,u,f,d,h,p,e=>p(e.href),function(e){Sn[e?"unshift":"push"]((()=>{a=e,n(0,a)}))}]}class ei extends er{constructor(e){super(),Xn(this,e,Xo,Yo,Tt,{results:1,resultsEl:0})}}const{window:ti}=Ht;function ni(e){let t,n,r;function o(t){e[13](t)}let i={results:e[0]};return void 0!==e[3]&&(i.resultsEl=e[3]),t=new ei({props:i}),Sn.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(){Gn(t.$$.fragment)},m(e,n){Zn(t,e,n),r=!0},p(e,r){const o={};var i;1&r&&(o.results=e[0]),!n&&8&r&&(n=!0,o.resultsEl=e[3],i=()=>n=!1,$n.push(i)),t.$set(o)},i(e){r||(_n(t.$$.fragment,e),r=!0)},o(e){Bn(t.$$.fragment,e),r=!1},d(e){Yn(t,e)}}}function ri(e){let t,n,r,o,i,s,a,l=e[0].length&&ni(e);return{c(){t=Gt("input"),r=Xt(),l&&l.c(),o=en(),rn(t,"type","search"),rn(t,"id","dmt-search-field"),rn(t,"aria-label","Search"),rn(t,"class","svelte-tuln0o"),an(t,"color",e[4]?"red":null),an(t,"border-color",e[4]?"red":null)},m(n,c){Jt(n,t,c),e[11](t),sn(t,e[1]),Jt(n,r,c),l&&l.m(n,c),Jt(n,o,c),i=!0,s||(a=[tn(ti,"pointerdown",e[10]),tn(t,"input",e[12]),tn(t,"keydown",e[9])],s=!0)},p(e,[n]){2&n&&t.value!==e[1]&&sn(t,e[1]),16&n&&an(t,"color",e[4]?"red":null),16&n&&an(t,"border-color",e[4]?"red":null),e[0].length?l?(l.p(e,n),1&n&&_n(l,1)):(l=ni(e),l.c(),_n(l,1),l.m(o.parentNode,o)):l&&(Un(),Bn(l,1,1,(()=>{l=null})),jn())},i(r){i||(r&&In((()=>{i&&(n||(n=zn(t,e[8],{duration:200},!0)),n.run(1))})),_n(l),i=!0)},o(r){r&&(n||(n=zn(t,e[8],{duration:200},!1)),n.run(0)),Bn(l),i=!1},d(i){i&&(Kt(t),Kt(r),Kt(o)),e[11](null),i&&n&&n.end(),l&&l.d(i),s=!1,Et(a)}}}function oi(e,t,n){let r,o,i,s;const a=rr(void 0);bn("#storeCurrentId",a);const{basePath:l,showModuleIcon:c,searchOptions:u,settingStores:f,stateStores:d}=vn("#dmtComponentData"),h=d.mainSearchVisible;Lt(e,h,(e=>n(15,o=e)));const p=f.themeAnimate;Lt(e,p,(e=>n(16,s=e)));const g=u?.fullName??!1,m=u?.limit??10,y=rr("");Lt(e,y,(e=>n(1,i=e)));const b=s?Po:()=>{},v=yt.debounce(((e,t)=>n(0,$=function(e,{basePath:t,showModuleIcon:n=!0,searchFullName:r=!1,searchLimit:o=10}={}){if(!globalThis.dmtSearchMainIndex||!globalThis.dmtSearchMainRows)return[];const i=e.trim();if(0===i.length)return[];const s=globalThis.dmtSearchMainIndex.search(`*${i}*`),a=[];for(let e=0;et.score-e.score));for(let e=Math.min(o,s.length),l=0;l${Sr(c.p,i)}.${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}(e,t))),250),w={basePath:l,showModuleIcon:c,searchFullName:g,searchLimit:m};let x,S,E=0,$=[];return yn((()=>x.focus())),e.$$.update=()=>{2&e.$$.dirty&&v(i,{...w}),1&e.$$.dirty&&$?.length&&(E=-1,a.set(void 0)),3&e.$$.dirty&&n(4,r=i.length&&!$?.length)},[$,i,x,S,r,h,p,y,b,function(e){switch(e.code){case"ArrowDown":if(0===$.length)return;E<$.length-1&&(a.set($[++E].id),e.preventDefault());break;case"ArrowUp":if(0===$.length)return;E>0&&(a.set($[--E].id),e.preventDefault());break;case"Enter":E>=0&&(window.location.href=$[E].href),e.preventDefault();break;case"Escape":o&&!i.length&&Ft(h,o=!1,o);break;case"Tab":if(0===$.length)return void e.preventDefault();e.shiftKey?E>0&&a.set($[--E].id):E<$.length-1&&a.set($[++E].id),e.preventDefault()}e.stopPropagation()},function(e){e.target===x||S?.contains?.(e.target)||Ft(h,o=!1,o)},function(e){Sn[e?"unshift":"push"]((()=>{x=e,n(2,x)}))},function(){i=this.value,y.set(i)},function(e){S=e,n(3,S)}]}class ii extends er{constructor(e){super(),Xn(this,e,oi,ri,Tt,{})}}function si(e){let t,n;return t=new ii({}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function ai(e){let t,n,r,o,i=e[0]&&si();return r=new Jo({}),{c(){i&&i.c(),t=Xt(),n=Gt("div"),Gn(r.$$.fragment),rn(n,"class","dmt-widget dmt-toolbar-icon search no-caption svelte-wmon9h")},m(e,s){i&&i.m(e,s),Jt(e,t,s),Jt(e,n,s),Zn(r,n,null),o=!0},p(e,[n]){e[0]?i?1&n&&_n(i,1):(i=si(),i.c(),_n(i,1),i.m(t.parentNode,t)):i&&(Un(),Bn(i,1,1,(()=>{i=null})),jn())},i(e){o||(_n(i),_n(r.$$.fragment,e),o=!0)},o(e){Bn(i),Bn(r.$$.fragment,e),o=!1},d(e){e&&(Kt(t),Kt(n)),i&&i.d(e),Yn(r)}}}function li(e,t,n){let r;const{stateStores:o}=vn("#dmtComponentData"),i=o.mainSearchVisible;return Lt(e,i,(e=>n(0,r=e))),[r,i]}class ci extends er{constructor(e){super(),Xn(this,e,li,ai,Tt,{})}}function ui(e){let t,n,r,o;return{c(){t=Gt("div"),rn(t,"class","tjs-focus-wrap svelte-kjcljd"),rn(t,"tabindex",n=e[0]?0:null)},m(n,i){Jt(n,t,i),e[4](t),r||(o=tn(t,"focus",e[2]),r=!0)},p(e,[r]){1&r&&n!==(n=e[0]?0:null)&&rn(t,"tabindex",n)},i:bt,o:bt,d(n){n&&Kt(t),e[4](null),r=!1,o()}}}function fi(e,t,n){let r,o,{elementRoot:i}=t,{enabled:s=!0}=t;return e.$$set=e=>{"elementRoot"in e&&n(3,i=e.elementRoot),"enabled"in e&&n(0,s=e.enabled)},e.$$.update=()=>{2&e.$$.dirty&&o&&(r=new Set([o]))},[s,o,function(){if(s&&dr.isFocusTarget(i)){const e=dr.getFirstFocusableElement(i,r);dr.isFocusTarget(e)&&e!==o?e.focus():i.focus()}},i,function(e){Sn[e?"unshift":"push"]((()=>{o=e,n(1,o)}))}]}class di extends er{constructor(e){super(),Xn(this,e,fi,ui,Tt,{elementRoot:3,enabled:0})}}function hi(e,t,n){const r=e.slice();return r[15]=t[n],r}function pi(e,t){let n,r,o,i,s,a,l;return{key:e,first:null,c(){n=Gt("a"),r=Gt("img"),s=Xt(),Ct(r.src,o=t[15].iconURL)||rn(r,"src",o),rn(r,"alt",i=t[15].title),rn(r,"class","svelte-1pcybcf"),rn(n,"href",a=t[15].url),rn(n,"target","_blank"),rn(n,"title",l=t[15].title),rn(n,"class","svelte-1pcybcf"),this.first=n},m(e,t){Jt(e,n,t),Vt(n,r),Vt(n,s)},p(e,s){t=e,2&s&&!Ct(r.src,o=t[15].iconURL)&&rn(r,"src",o),2&s&&i!==(i=t[15].title)&&rn(r,"alt",i),2&s&&a!==(a=t[15].url)&&rn(n,"href",a),2&s&&l!==(l=t[15].title)&&rn(n,"title",l)},d(e){e&&Kt(n)}}}function gi(e){let t,n,r,o,i,s,a,l,c=[],u=new Map,f=Hn(e[1].icons);const d=e=>e[15].url;for(let t=0;t{s&&(i||(i=zn(t,e[4],{duration:250,easing:Oo},!0)),i.run(1))})),s=!0)},o(n){Bn(o.$$.fragment,n),i||(i=zn(t,e[4],{duration:250,easing:Oo},!1)),i.run(0),s=!1},d(n){n&&Kt(t);for(let e=0;en(1,i=e)));const{themeAnimate:c}=a;Lt(e,c,(e=>n(11,o=e)));const u=o?Po:()=>{},f={ignoreClasses:["tjs-focus-wrap"]},d=vn("menuVisible");let h;return Lt(e,d,(e=>n(10,r=e))),yn((()=>h.focus())),[h,i,l,c,u,d,function(e){if("Tab"===e.code)if(e.stopPropagation(),e.shiftKey){const t=dr.getFocusableElements(h,f),n=t.length>0?t[0]:void 0,r=t.length>0?t[t.length-1]:void 0;h!==globalThis.document.activeElement&&n!==globalThis.document.activeElement||(r instanceof HTMLElement&&n!==r&&r.focus(),e.preventDefault())}e.stopPropagation()},function(e){if("Escape"===e.code)Ft(d,r=!1,r),e.preventDefault();e.stopPropagation()},function(e){h?.parentElement?.contains?.(e.target)||Ft(d,r=!1,r)},function(e){Sn[e?"unshift":"push"]((()=>{h=e,n(0,h)}))}]}class yi extends er{constructor(e){super(),Xn(this,e,mi,gi,Tt,{})}}function bi(e){let t,n;return t=new yi({props:{buttonHostEl:e[0]}}),{c(){Gn(t.$$.fragment)},m(e,r){Zn(t,e,r),n=!0},p(e,n){const r={};1&n&&(r.buttonHostEl=e[0]),t.$set(r)},i(e){n||(_n(t.$$.fragment,e),n=!0)},o(e){Bn(t.$$.fragment,e),n=!1},d(e){Yn(t,e)}}}function vi(e){let t,n,r,o,i,s,a=e[1]&&bi(e);return{c(){t=Gt("section"),n=Gt("button"),n.innerHTML='',r=Xt(),a&&a.c(),rn(n,"class","svelte-1ebh1s9"),rn(t,"class","svelte-1ebh1s9")},m(l,c){Jt(l,t,c),Vt(t,n),Vt(t,r),a&&a.m(t,null),e[5](t),o=!0,i||(s=[tn(n,"click",e[4]),tn(n,"pointerdown",nn(e[3]))],i=!0)},p(e,[n]){e[1]?a?(a.p(e,n),2&n&&_n(a,1)):(a=bi(e),a.c(),_n(a,1),a.m(t,null)):a&&(Un(),Bn(a,1,1,(()=>{a=null})),jn())},i(e){o||(_n(a),o=!0)},o(e){Bn(a),o=!1},d(n){n&&Kt(t),a&&a.d(),e[5](null),i=!1,Et(s)}}}function wi(e,t,n){let r;const o=rr(!1);let i;Lt(e,o,(e=>n(1,r=e))),bn("menuVisible",o);return[i,r,o,function(t){wn.call(this,e,t)},()=>Ft(o,r=!r,r),function(e){Sn[e?"unshift":"push"]((()=>{i=e,n(0,i)}))}]}class xi extends er{constructor(e){super(),Xn(this,e,wi,vi,Tt,{})}}function Si(e,t,n){const r=e.slice();return r[3]=t[n],r}function Ei(e,t){let n,r,o,i,s,a,l;return{key:e,first:null,c(){n=Gt("a"),r=Gt("img"),s=Xt(),Ct(r.src,o=t[3].iconURL)||rn(r,"src",o),rn(r,"alt",i=t[3].title),rn(r,"class","svelte-1f93d1m"),rn(n,"href",a=t[3].url),rn(n,"target","_blank"),rn(n,"title",l=t[3].title),rn(n,"class","svelte-1f93d1m"),this.first=n},m(e,t){Jt(e,n,t),Vt(n,r),Vt(n,s)},p(e,s){t=e,1&s&&!Ct(r.src,o=t[3].iconURL)&&rn(r,"src",o),1&s&&i!==(i=t[3].title)&&rn(r,"alt",i),1&s&&a!==(a=t[3].url)&&rn(n,"href",a),1&s&&l!==(l=t[3].title)&&rn(n,"title",l)},d(e){e&&Kt(n)}}}function $i(e){let t,n=[],r=new Map,o=Hn(e[0].icons);const i=e=>e[3].url;for(let t=0;tn(0,r=e))),[r,i]}class ki extends er{constructor(e){super(),Xn(this,e,Ti,$i,Tt,{})}}function Ci(e){let t,n,r;var o=e[1];return o&&(t=cn(o,{})),{c(){t&&Gn(t.$$.fragment),n=en()},m(e,o){t&&Zn(t,e,o),Jt(e,n,o),r=!0},p(e,r){if(2&r&&o!==(o=e[1])){if(t){Un();const e=t;Bn(e.$$.fragment,1,0,(()=>{Yn(e,1)})),jn()}o?(t=cn(o,{}),Gn(t.$$.fragment),_n(t.$$.fragment,1),Zn(t,n.parentNode,n)):t=null}},i(e){r||(t&&_n(t.$$.fragment,e),r=!0)},o(e){t&&Bn(t.$$.fragment,e),r=!1},d(e){e&&Kt(n),t&&Yn(t,e)}}}function Oi(e){let t,n,r=e[0].icons.length&&Ci(e);return{c(){r&&r.c(),t=en()},m(e,o){r&&r.m(e,o),Jt(e,t,o),n=!0},p(e,[n]){e[0].icons.length?r?(r.p(e,n),1&n&&_n(r,1)):(r=Ci(e),r.c(),_n(r,1),r.m(t.parentNode,t)):r&&(Un(),Bn(r,1,1,(()=>{r=null})),jn())},i(e){n||(_n(r),n=!0)},o(e){Bn(r),n=!1},d(e){e&&Kt(t),r&&r.d(e)}}}function Ii(e,t,n){let r,o;const{componentStores:i}=vn("#dmtComponentData"),s=vn("toolbarOffsetWidth");Lt(e,s,(e=>n(4,r=e)));const{toolbarIconLinks:a}=i;Lt(e,a,(e=>n(0,o=e)));let l=ki;return e.$$.update=()=>{17&e.$$.dirty&&r>0&&(o.totalWidth>0&&n(1,l=o.totalWidth>r?xi:ki),r<40&&n(1,l=void 0))},[o,l,s,a,r]}class Li extends er{constructor(e){super(),Xn(this,e,Ii,Oi,Tt,{})}}function Pi(e){let t,n,r,o,i,s;return n=new Li({}),{c(){t=Gt("section"),Gn(n.$$.fragment),rn(t,"class","svelte-j9157o")},m(a,l){Jt(a,t,l),Zn(n,t,null),o=!0,i||(s=Ut(r=mt.call(null,t,e[2])),i=!0)},p(e,[t]){r&&$t(r.update)&&1&t&&r.update.call(null,e[2])},i(e){o||(_n(n.$$.fragment,e),o=!0)},o(e){Bn(n.$$.fragment,e),o=!1},d(e){e&&Kt(t),Yn(n),i=!1,s()}}}function Ai(e,t,n){let r;const o=rr(0);Lt(e,o,(e=>n(0,r=e))),bn("toolbarOffsetWidth",o);return[r,o,e=>Ft(o,r=e,r)]}globalThis.dmtInflateAndUnpack=function(e,{inflateOptions:t}={}){return Z(Je(e,t))},globalThis.dmtInflateAndUnpackB64=function(e,{inflateOptions:t}={}){return Z(Je(ot(it(e)),t))};const Mi=new class{#Z;#Y;#X;#ee;#te;#ne;#re={local:new cr,session:new ur};constructor(e){this.#Y="string"==typeof globalThis.dmtComponentDataBCMP?globalThis.dmtInflateAndUnpackB64(globalThis.dmtComponentDataBCMP):{};const t=e.replace(/assets\/dmt\/dmt-components.js/,""),n=e.replace(/dmt-components.js/,""),r=globalThis.location.href.replace(t,""),o=(r.match(/\//)??[]).length,i="../".repeat(o);this.#X={basePath:i,baseURL:t,dmtURL:n,initialPathURL:r},this.#ee=new yr(this,this.#Y.navigationIndex),this.#Z=Object.freeze({toolbarIconLinks:kr(this,this.#Y)});const s="boolean"!=typeof this.#Y?.settingOptions?.animation||this.#Y?.settingOptions?.animation;this.#te=Object.freeze({themeAnimate:s?this.#re.local.getStore(Cr,!dr.prefersReducedMotion):nr(!1)}),this.#ne=Object.freeze({helpPanelVisible:rr(!1),mainSearchVisible:rr(!1),swapHelpPanelVisible:()=>this.#ne.helpPanelVisible.set(!It(this.#ne.helpPanelVisible))})}get basePath(){return this.#X.basePath}get baseURL(){return this.#X.baseURL}get componentStores(){return this.#Z}get dmtLocalStorage(){return this.#re.local}get dmtSessionStorage(){return this.#re.session}get dmtURL(){return this.#X.dmtURL}get initialPathURL(){return this.#X.initialPathURL}get navigation(){return this.#ee}get settingStores(){return this.#te}get stateStores(){return this.#ne}get iconLinks(){return this.#Y.iconLinks}get pageIndex(){return this.#Y.pageIndex??{}}get moduleIsPackage(){return this.#Y.moduleIsPackage??!1}get showModuleIcon(){return this.#Y.showModuleIcon??!0}get searchOptions(){return this.#Y.searchOptions}get ReflectionKind(){return this.#Y.ReflectionKind}get sidebarLinks(){return this.#Y?.sidebarLinks??{}}get storagePrepend(){return this.#Y.storagePrepend??"docs-unnamed"}}(import.meta.url),Di=new Map([["#dmtComponentData",Mi]]),Ni=new class extends er{constructor(e){super(),Xn(this,e,Ar,Pr,Tt,{})}}({target:document.querySelector(".tsd-navigation.settings .tsd-accordion-details"),context:Di}),Ri=document.querySelector("nav#tsd-sidebar-links");Ri&&Ri.remove();const Fi=document.querySelector("nav.tsd-navigation");if(Fi&&Fi.firstChild)for(;Fi.firstChild;)Fi.removeChild(Fi.firstChild);const Ui=new class extends er{constructor(e){super(),Xn(this,e,null,Vo,Tt,{})}}({target:document.querySelector("nav.tsd-navigation"),context:Di}),ji=new class extends er{constructor(e){super(),Xn(this,e,Ai,Pi,Tt,{})}}({target:document.querySelector("#dmt-toolbar"),context:Di});globalThis.dmtComponents={dmtSettings:Ni,navigation:Ui,toolbar:ji},Mi.searchOptions&&(!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=xr.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 ci({target:document.querySelector("#dmt-search-main"),context:Di})),function(e){const{baseURL:t,dmtSessionStorage:n,pageIndex:r,navigation:o,stateStores:i,storagePrepend:s}=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=dr.getFirstFocusableElement(t);e&&e.focus({focusVisible:!0})}e.preventDefault();break}case"KeyD":{const t=`${s}-document-index`;n.hasStore(t)&&(n.getStore(t).set(!0),setTimeout((()=>{const e=globalThis.document.querySelector("section.dmt-document-index");if(e){const t=e.querySelector("a");t&&t.focus({focusVisible:!0})}}),0)),e.preventDefault();break}case"KeyE":o.treeState.source.swapFoldersAllOpen(),e.preventDefault();break;case"KeyH":i.swapHelpPanelVisible(),e.preventDefault();break;case"KeyI":globalThis.location.href=`${t}index.html`,e.preventDefault();break;case"KeyM":"string"==typeof r.modules&&(globalThis.location.href=`${t}${r.modules}`),e.preventDefault();break;case"KeyN":o.treeState.ensureCurrentPath({focus:!0}),e.preventDefault();break;case"KeyO":fr.openOnThisPage(),e.preventDefault();break;case"KeyS":i.mainSearchVisible.set(!0),e.preventDefault();break;case"KeyY":"string"==typeof r.hierarchy&&(globalThis.location.href=`${t}${r.hierarchy}`),e.preventDefault()}}))}(Mi),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})))}))}(),fr.initialize(Mi),globalThis.requestAnimationFrame((()=>{const e=document.createElement("style");e.innerHTML="body { visibility: visible; }",document.head.appendChild(e);const t=document.querySelector("body main footer");t&&document.documentElement.style.setProperty("--dmt-footer-height",`${t.offsetHeight}px`)})); diff --git a/docs/assets/dmt/dmt-search.cmp b/docs/assets/dmt/dmt-search.cmp index 7c411c5..fe8644b 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 f5fe689..bbaedfa 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.5rem 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{contain:layout style paint;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{contain:layout style paint;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{contain:layout style paint;display:flex;flex-direction:column;gap:1rem;max-height:var(--dmt-page-menu-max-height);overflow:revert;padding:.75rem .5rem .5rem;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{will-change:height}details.tsd-accordion[open]:not(details[data-closing=true])>summary svg{transform:rotate(0deg)}details.tsd-accordion:not([open])>summary 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-index-group .tsd-index-list{overflow:auto}.container .tsd-panel-group.tsd-index-group .tsd-index-list.col1-grid{grid-template-columns:repeat(1,1fr)}.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 +: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.5rem 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{contain:layout style paint;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{contain:layout style paint;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{contain:layout style paint;display:flex;flex-direction:column;gap:1rem;max-height:var(--dmt-page-menu-max-height);overflow:revert;padding:.75rem .5rem .5rem;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{will-change:height}details.tsd-accordion[open]:not(details[data-closing=true])>summary svg{transform:rotate(0deg)}details.tsd-accordion:not([open])>summary 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-index-group .tsd-index-list{overflow:auto}.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-x:hidden;overflow-y: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::details-content{display:contents}.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:.5rem}.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}.page-menu .tsd-page-navigation details.tsd-page-navigation-section>div{margin-left:8px;overflow-wrap:anywhere;width:calc(100% + 10px)} \ No newline at end of file diff --git a/docs/assets/icons.js b/docs/assets/icons.js index 3dfbd32..58882d7 100644 --- a/docs/assets/icons.js +++ b/docs/assets/icons.js @@ -3,7 +3,7 @@ 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 = `MMNEPVFCICPMFPCPTTAAATR`; + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; svg.style.display = "none"; if (location.protocol === "file:") updateUseElements(); } diff --git a/docs/assets/icons.svg b/docs/assets/icons.svg index a19417d..50ad579 100644 --- a/docs/assets/icons.svg +++ b/docs/assets/icons.svg @@ -1 +1 @@ -MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/docs/assets/main.js b/docs/assets/main.js index 58c5cbb..c9c3ee3 100644 --- a/docs/assets/main.js +++ b/docs/assets/main.js @@ -1,9 +1,9 @@ "use strict"; -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{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.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});})(); +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse"}; +"use strict";(()=>{var De=Object.create;var le=Object.defineProperty;var Fe=Object.getOwnPropertyDescriptor;var Ne=Object.getOwnPropertyNames;var Ve=Object.getPrototypeOf,Be=Object.prototype.hasOwnProperty;var qe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var je=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ne(e))!Be.call(t,i)&&i!==n&&le(t,i,{get:()=>e[i],enumerable:!(r=Fe(e,i))||r.enumerable});return t};var $e=(t,e,n)=>(n=t!=null?De(Ve(t)):{},je(e||!t||!t.__esModule?le(n,"default",{value:t,enumerable:!0}):n,t));var pe=qe((de,he)=>{(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,c],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[c+1]*i[d+1],c+=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 c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}s.str.length==1&&(c.final=!0),i.push({node:c,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 de=="object"?he.exports=n():e.lunr=n()}(this,function(){return t})})()});window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse"};var ce=[];function G(t,e){ce.push({selector:e,constructor:t})}var J=class{alwaysVisibleMember=null;constructor(){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){ce.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&&!ze(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 ze(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var ue=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var ge=$e(pe(),1);async function H(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).text();return JSON.parse(i)}async function fe(t,e){if(!window.searchData)return;let n=await H(window.searchData);t.data=n,t.index=ge.Index.load(n.index),e.classList.remove("loading"),e.classList.add("ready")}function ve(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:document.documentElement.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",()=>{fe(e,t)}),fe(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",()=>{re(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),We(t,i,r,e)}function We(t,e,n,r){n.addEventListener("input",ue(()=>{Ue(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Je(e,t):i.key=="ArrowUp"?(me(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(me(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(),re(t))})}function re(t){t.classList.remove("has-focus")}function Ue(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=ye(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ye(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=c+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function me(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 Je(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),re(e)}}function ye(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(ne(t.substring(s,o)),`${ne(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ne(t.substring(s))),i.join("")}var Ge={"&":"&","<":"<",">":">","'":"'",'"':"""};function ne(t){return t.replace(/[&<>"'"]/g,e=>Ge[e])}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var A="mousedown",Ee="mousemove",B="mouseup",X={x:0,y:0},xe=!1,ie=!1,Xe=!1,D=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Xe=!0,A="touchstart",Ee="touchmove",B="touchend");document.addEventListener(A,t=>{ie=!0,D=!1;let e=A=="touchstart"?t.targetTouches[0]:t;X.y=e.pageY||0,X.x=e.pageX||0});document.addEventListener(Ee,t=>{if(ie&&!D){let e=A=="touchstart"?t.targetTouches[0]:t,n=X.x-(e.pageX||0),r=X.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var Y=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(A,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,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 se;try{se=localStorage}catch{se={getItem(){return null},setItem(){}}}var C=se;var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var Z=class extends I{key;value;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()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=C.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){C.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 oe=new Map,ae=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;C.setItem(this.key,e.toString())}},K=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(oe.has(i))s=oe.get(i);else{let o=C.getItem(i),a=o?o==="true":this.el.open;s=new ae(i,a),oe.set(i,s)}s.add(this.el)}};function Se(t){let e=C.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{C.setItem("tsd-theme",t.value),we(t.value)})}function we(t){document.documentElement.dataset.theme=t}var ee;function Ce(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Te),Te())}async function Te(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await H(window.navigationData);ee=document.documentElement.dataset.base,ee.endsWith("/")||(ee+="/"),t.innerHTML="";for(let n of e)Ie(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Ie(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='',ke(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 c of t.children)Ie(c,l,i)}else ke(t,r,t.class)}function ke(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=ee+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{let r=e.appendChild(document.createElement("span"));r.innerHTML='',r.appendChild(document.createElement("span")).textContent=t.text}}var te=document.documentElement.dataset.base;te.endsWith("/")||(te+="/");function Pe(){document.querySelector(".tsd-full-hierarchy")?Ye():document.querySelector(".tsd-hierarchy")&&Ze()}function Ye(){document.addEventListener("click",r=>{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=tt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function Ze(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Qe),Qe())}async function Qe(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await H(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),Ke(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function Ke(t,e,n){let r=e.roots.filter(i=>et(e,i,n));for(let i of r)t.appendChild(Oe(e,i,n))}function Oe(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let l=t.reflections[a],c=s.appendChild(document.createElement("a"));c.textContent=l.name,c.href=te+l.url,c.className=l.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=te+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let l=Oe(t,a,n,r);l&&o.appendChild(l)}}return r.delete(e),s}function et(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function tt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}G(Y,"a[data-toggle]");G(Z,".tsd-filter-item input[type=checkbox]");var _e=document.getElementById("tsd-theme");_e&&Se(_e);var nt=new J;Object.defineProperty(window,"app",{value:nt});})(); /*! Bundled license information: lunr/lunr.js: diff --git a/docs/assets/style.css b/docs/assets/style.css index 178bfb0..7f80f3d 100644 --- a/docs/assets/style.css +++ b/docs/assets/style.css @@ -1,115 +1,256 @@ -:root { - /* Light */ - --light-color-background: #f2f4f8; - --light-color-background-secondary: #eff0f1; - --light-color-warning-text: #222; - --light-color-background-warning: #e6e600; - --light-color-accent: #c5c7c9; - --light-color-active-menu-item: var(--light-color-accent); - --light-color-text: #222; - --light-color-text-aside: #6e6e6e; - - --light-color-icon-background: var(--light-color-background); - --light-color-icon-text: var(--light-color-text); - - --light-color-comment-tag-text: var(--light-color-text); - --light-color-comment-tag: var(--light-color-background); - - --light-color-link: #1f70c2; - --light-color-focus-outline: #3584e4; - - --light-color-ts-keyword: #056bd6; - --light-color-ts-project: #b111c9; - --light-color-ts-module: var(--light-color-ts-project); - --light-color-ts-namespace: var(--light-color-ts-project); - --light-color-ts-enum: #7e6f15; - --light-color-ts-enum-member: var(--light-color-ts-enum); - --light-color-ts-variable: #4760ec; - --light-color-ts-function: #572be7; - --light-color-ts-class: #1f70c2; - --light-color-ts-interface: #108024; - --light-color-ts-constructor: #4d7fff; - --light-color-ts-property: #ff984d; - --light-color-ts-method: #ff4db8; - --light-color-ts-reference: #ff4d82; - --light-color-ts-call-signature: var(--light-color-ts-method); - --light-color-ts-index-signature: var(--light-color-ts-property); - --light-color-ts-constructor-signature: var(--light-color-ts-constructor); - --light-color-ts-parameter: var(--light-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --light-color-ts-type-parameter: #a55c0e; - --light-color-ts-accessor: #ff4d4d; - --light-color-ts-get-signature: var(--light-color-ts-accessor); - --light-color-ts-set-signature: var(--light-color-ts-accessor); - --light-color-ts-type-alias: #d51270; - /* reference not included as links will be colored with the kind that it points to */ - --light-color-document: #000000; - - --light-external-icon: url("data:image/svg+xml;utf8,"); - --light-color-scheme: light; - - /* Dark */ - --dark-color-background: #2b2e33; - --dark-color-background-secondary: #1e2024; - --dark-color-background-warning: #bebe00; - --dark-color-warning-text: #222; - --dark-color-accent: #9096a2; - --dark-color-active-menu-item: #5d5d6a; - --dark-color-text: #f5f5f5; - --dark-color-text-aside: #dddddd; - - --dark-color-icon-background: var(--dark-color-background-secondary); - --dark-color-icon-text: var(--dark-color-text); - - --dark-color-comment-tag-text: var(--dark-color-text); - --dark-color-comment-tag: var(--dark-color-background); - - --dark-color-link: #00aff4; - --dark-color-focus-outline: #4c97f2; - - --dark-color-ts-keyword: #3399ff; - --dark-color-ts-project: #e358ff; - --dark-color-ts-module: var(--dark-color-ts-project); - --dark-color-ts-namespace: var(--dark-color-ts-project); - --dark-color-ts-enum: #f4d93e; - --dark-color-ts-enum-member: var(--dark-color-ts-enum); - --dark-color-ts-variable: #798dff; - --dark-color-ts-function: #a280ff; - --dark-color-ts-class: #8ac4ff; - --dark-color-ts-interface: #6cff87; - --dark-color-ts-constructor: #4d7fff; - --dark-color-ts-property: #ff984d; - --dark-color-ts-method: #ff4db8; - --dark-color-ts-reference: #ff4d82; - --dark-color-ts-call-signature: var(--dark-color-ts-method); - --dark-color-ts-index-signature: var(--dark-color-ts-property); - --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); - --dark-color-ts-parameter: var(--dark-color-ts-variable); - /* type literal not included as links will never be generated to it */ - --dark-color-ts-type-parameter: #e07d13; - --dark-color-ts-accessor: #ff4d4d; - --dark-color-ts-get-signature: var(--dark-color-ts-accessor); - --dark-color-ts-set-signature: var(--dark-color-ts-accessor); - --dark-color-ts-type-alias: #ff6492; - /* reference not included as links will be colored with the kind that it points to */ - --dark-color-document: #ffffff; - - --dark-external-icon: url("data:image/svg+xml;utf8,"); - --dark-color-scheme: dark; -} - -@media (prefers-color-scheme: light) { +@layer typedoc { :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + --light-color-warning-text: #222; + --light-color-background-warning: #e6e600; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-accent); + --light-color-text: #222; + --light-color-text-aside: #6e6e6e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: #5d5d6a; + --dark-color-text: #f5f5f5; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + html { + color-scheme: var(--color-scheme); + } + + body { + margin: 0; + } + + :root[data-theme="light"] { --color-background: var(--light-color-background); --color-background-secondary: var(--light-color-background-secondary); --color-background-warning: var(--light-color-background-warning); --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); --color-accent: var(--light-color-accent); --color-active-menu-item: var(--light-color-active-menu-item); --color-text: var(--light-color-text); --color-text-aside: var(--light-color-text-aside); - - --color-icon-background: var(--light-color-icon-background); --color-icon-text: var(--light-color-icon-text); --color-comment-tag-text: var(--light-color-text); @@ -145,23 +286,26 @@ --color-ts-type-alias: var(--light-color-ts-type-alias); --color-document: var(--light-color-document); + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + --external-icon: var(--light-external-icon); --color-scheme: var(--light-color-scheme); } -} -@media (prefers-color-scheme: dark) { - :root { + :root[data-theme="dark"] { --color-background: var(--dark-color-background); --color-background-secondary: var(--dark-color-background-secondary); --color-background-warning: var(--dark-color-background-warning); --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); --color-accent: var(--dark-color-accent); --color-active-menu-item: var(--dark-color-active-menu-item); --color-text: var(--dark-color-text); --color-text-aside: var(--dark-color-text-aside); - - --color-icon-background: var(--dark-color-icon-background); --color-icon-text: var(--dark-color-icon-text); --color-comment-tag-text: var(--dark-color-text); @@ -197,1297 +341,1270 @@ --color-ts-type-alias: var(--dark-color-ts-type-alias); --color-document: var(--dark-color-document); + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + --external-icon: var(--dark-external-icon); --color-scheme: var(--dark-color-scheme); } -} -html { - color-scheme: var(--color-scheme); -} - -body { - margin: 0; -} + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } -:root[data-theme="light"] { - --color-background: var(--light-color-background); - --color-background-secondary: var(--light-color-background-secondary); - --color-background-warning: var(--light-color-background-warning); - --color-warning-text: var(--light-color-warning-text); - --color-icon-background: var(--light-color-icon-background); - --color-accent: var(--light-color-accent); - --color-active-menu-item: var(--light-color-active-menu-item); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-icon-text: var(--light-color-icon-text); - - --color-comment-tag-text: var(--light-color-text); - --color-comment-tag: var(--light-color-background); - - --color-link: var(--light-color-link); - --color-focus-outline: var(--light-color-focus-outline); - - --color-ts-keyword: var(--light-color-ts-keyword); - --color-ts-project: var(--light-color-ts-project); - --color-ts-module: var(--light-color-ts-module); - --color-ts-namespace: var(--light-color-ts-namespace); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-enum-member: var(--light-color-ts-enum-member); - --color-ts-variable: var(--light-color-ts-variable); - --color-ts-function: var(--light-color-ts-function); - --color-ts-class: var(--light-color-ts-class); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-constructor: var(--light-color-ts-constructor); - --color-ts-property: var(--light-color-ts-property); - --color-ts-method: var(--light-color-ts-method); - --color-ts-reference: var(--light-color-ts-reference); - --color-ts-call-signature: var(--light-color-ts-call-signature); - --color-ts-index-signature: var(--light-color-ts-index-signature); - --color-ts-constructor-signature: var( - --light-color-ts-constructor-signature - ); - --color-ts-parameter: var(--light-color-ts-parameter); - --color-ts-type-parameter: var(--light-color-ts-type-parameter); - --color-ts-accessor: var(--light-color-ts-accessor); - --color-ts-get-signature: var(--light-color-ts-get-signature); - --color-ts-set-signature: var(--light-color-ts-set-signature); - --color-ts-type-alias: var(--light-color-ts-type-alias); - --color-document: var(--light-color-document); - - --external-icon: var(--light-external-icon); - --color-scheme: var(--light-color-scheme); -} + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } -:root[data-theme="dark"] { - --color-background: var(--dark-color-background); - --color-background-secondary: var(--dark-color-background-secondary); - --color-background-warning: var(--dark-color-background-warning); - --color-warning-text: var(--dark-color-warning-text); - --color-icon-background: var(--dark-color-icon-background); - --color-accent: var(--dark-color-accent); - --color-active-menu-item: var(--dark-color-active-menu-item); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-icon-text: var(--dark-color-icon-text); - - --color-comment-tag-text: var(--dark-color-text); - --color-comment-tag: var(--dark-color-background); - - --color-link: var(--dark-color-link); - --color-focus-outline: var(--dark-color-focus-outline); - - --color-ts-keyword: var(--dark-color-ts-keyword); - --color-ts-project: var(--dark-color-ts-project); - --color-ts-module: var(--dark-color-ts-module); - --color-ts-namespace: var(--dark-color-ts-namespace); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-enum-member: var(--dark-color-ts-enum-member); - --color-ts-variable: var(--dark-color-ts-variable); - --color-ts-function: var(--dark-color-ts-function); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-constructor: var(--dark-color-ts-constructor); - --color-ts-property: var(--dark-color-ts-property); - --color-ts-method: var(--dark-color-ts-method); - --color-ts-reference: var(--dark-color-ts-reference); - --color-ts-call-signature: var(--dark-color-ts-call-signature); - --color-ts-index-signature: var(--dark-color-ts-index-signature); - --color-ts-constructor-signature: var( - --dark-color-ts-constructor-signature - ); - --color-ts-parameter: var(--dark-color-ts-parameter); - --color-ts-type-parameter: var(--dark-color-ts-type-parameter); - --color-ts-accessor: var(--dark-color-ts-accessor); - --color-ts-get-signature: var(--dark-color-ts-get-signature); - --color-ts-set-signature: var(--dark-color-ts-set-signature); - --color-ts-type-alias: var(--dark-color-ts-type-alias); - --color-document: var(--dark-color-document); - - --external-icon: var(--dark-external-icon); - --color-scheme: var(--dark-color-scheme); -} + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } -*:focus-visible, -.tsd-accordion-summary:focus-visible svg { - outline: 2px solid var(--color-focus-outline); -} + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } -.always-visible, -.always-visible .tsd-signatures { - display: inherit !important; -} + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } -h1, -h2, -h3, -h4, -h5, -h6 { - line-height: 1.2; -} + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } -h1 { - font-size: 1.875rem; - margin: 0.67rem 0; -} + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } -h2 { - font-size: 1.5rem; - margin: 0.83rem 0; -} + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } -h3 { - font-size: 1.25rem; - margin: 1rem 0; -} + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } -h4 { - font-size: 1.05rem; - margin: 1.33rem 0; -} + dl, + menu, + ol, + ul { + margin: 1em 0; + } -h5 { - font-size: 1rem; - margin: 1.5rem 0; -} + dd { + margin: 0 0 0 34px; + } -h6 { - font-size: 0.875rem; - margin: 2.33rem 0; -} + .container { + max-width: 1700px; + padding: 0 2rem; + } -dl, -menu, -ol, -ul { - margin: 1em 0; -} + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: 3.5rem; + } + footer > p { + margin: 0 1em; + } -dd { - margin: 0 0 0 40px; -} + .container-main { + margin: 0 auto; + /* toolbar, footer, margin */ + min-height: calc(100vh - 41px - 56px - 4rem); + } -.container { - max-width: 1700px; - padding: 0 2rem; -} + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes fade-in-delayed { + 0% { + opacity: 0; + } + 33% { + opacity: 0; + } + 100% { + opacity: 1; + } + } + @keyframes fade-out-delayed { + 0% { + opacity: 1; + visibility: visible; + } + 66% { + opacity: 0; + } + 100% { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + } -/* Footer */ -footer { - border-top: 1px solid var(--color-accent); - padding-top: 1rem; - padding-bottom: 1rem; - max-height: 3.5rem; -} -footer > p { - margin: 0 1em; -} + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } -.container-main { - margin: 0 auto; - /* toolbar, footer, margin */ - min-height: calc(100vh - 41px - 56px - 4rem); -} + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } -@keyframes fade-in { - from { + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; } - to { + pre:hover > button, + pre > button.visible { opacity: 1; } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; } - to { - opacity: 0; + + .tsd-typography { + line-height: 1.333em; } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; } - 33% { - opacity: 0; + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; } - 100% { - opacity: 1; + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; } - 66% { - opacity: 0; + .tsd-typography table { + border-collapse: collapse; + border: none; } - 100% { - opacity: 0; + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); } - to { - transform: translate(0, 0); + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; } - to { - transform: translate(100%, 0); + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; } -} -body { - background: var(--color-background); - font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", - Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; - font-size: 16px; - color: var(--color-text); -} -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} -a.tsd-anchor-link { - color: var(--color-text); -} + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 0.875rem; - border-radius: 0.8em; -} + .tsd-breadcrumb { + margin: 0; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } -pre { - position: relative; - white-space: pre-wrap; - word-wrap: break-word; - padding: 10px; - border: 1px solid var(--color-accent); -} -pre code { - padding: 0; - font-size: 100%; -} -pre > button { - position: absolute; - top: 10px; - right: 10px; - opacity: 0; - transition: opacity 0.1s; - box-sizing: border-box; -} -pre:hover > button, -pre > button.visible { - opacity: 1; -} + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h4, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} -.tsd-typography table { - border-collapse: collapse; - border: none; -} -.tsd-typography td, -.tsd-typography th { - padding: 6px 13px; - border: 1px solid var(--color-accent); -} -.tsd-typography thead, -.tsd-typography tr:nth-child(even) { - background-color: var(--color-background-secondary); -} + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } -.tsd-comment-tags { - display: flex; - flex-direction: column; -} -dl.tsd-comment-tag-group { - display: flex; - align-items: center; - overflow: hidden; - margin: 0.5em 0; -} -dl.tsd-comment-tag-group dt { - display: flex; - margin-right: 0.5em; - font-size: 0.875em; - font-weight: normal; -} -dl.tsd-comment-tag-group dd { - margin: 0; -} -code.tsd-tag { - padding: 0.25em 0.4em; - border: 0.1em solid var(--color-accent); - margin-right: 0.25em; - font-size: 70%; -} -h1 code.tsd-tag:first-of-type { - margin-left: 0.25em; -} + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } -dl.tsd-comment-tag-group dd:before, -dl.tsd-comment-tag-group dd:after { - content: " "; -} -dl.tsd-comment-tag-group dd pre, -dl.tsd-comment-tag-group dd:after { - clear: both; -} -dl.tsd-comment-tag-group p { - margin: 0; -} + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } -.tsd-filter-visibility h4 { - font-size: 1rem; - padding-top: 0.75rem; - padding-bottom: 0.5rem; - margin: 0; -} -.tsd-filter-item:not(:last-child) { - margin-bottom: 0.5rem; -} -.tsd-filter-input { - display: flex; - width: -moz-fit-content; - width: fit-content; - align-items: center; - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; - cursor: pointer; -} -.tsd-filter-input input[type="checkbox"] { - cursor: pointer; - position: absolute; - width: 1.5em; - height: 1.5em; - opacity: 0; -} -.tsd-filter-input input[type="checkbox"]:disabled { - pointer-events: none; -} -.tsd-filter-input svg { - cursor: pointer; - width: 1.5em; - height: 1.5em; - margin-right: 0.5em; - border-radius: 0.33em; - /* Leaving this at full opacity breaks event listeners on Firefox. - Don't remove unless you know what you're doing. */ - opacity: 0.99; -} -.tsd-filter-input input[type="checkbox"]:focus-visible + svg { - outline: 2px solid var(--color-focus-outline); -} -.tsd-checkbox-background { - fill: var(--color-accent); -} -input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { - stroke: var(--color-text); -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { - fill: var(--color-background); - stroke: var(--color-accent); - stroke-width: 0.25rem; -} -.tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { - stroke: var(--color-accent); -} + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } -.settings-label { - font-weight: bold; - text-transform: uppercase; - display: inline-block; -} + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } -.tsd-filter-visibility .settings-label { - margin: 0.75rem 0 0.5rem 0; -} + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } -.tsd-theme-toggle .settings-label { - margin: 0.75rem 0.75rem 0 0; -} + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } -.tsd-hierarchy { - list-style: square; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } -.tsd-full-hierarchy:not(:last-child) { - margin-bottom: 1em; - padding-bottom: 1em; - border-bottom: 1px solid var(--color-accent); -} -.tsd-full-hierarchy, -.tsd-full-hierarchy ul { - list-style: none; - margin: 0; - padding: 0; -} -.tsd-full-hierarchy ul { - padding-left: 1.5rem; -} -.tsd-full-hierarchy a { - padding: 0.25rem 0 !important; - font-size: 1rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} + .tsd-anchor { + position: relative; + top: -100px; + } -.tsd-panel-group.tsd-index-group { - margin-bottom: 0; -} -.tsd-index-panel .tsd-index-list { - list-style: none; - line-height: 1.333em; - margin: 0; - padding: 0.25rem 0 0 0; - overflow: hidden; - display: grid; - grid-template-columns: repeat(3, 1fr); - column-gap: 1rem; - grid-template-rows: auto; -} -@media (max-width: 1024px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(2, 1fr); + .tsd-member { + position: relative; } -} -@media (max-width: 768px) { - .tsd-index-panel .tsd-index-list { - grid-template-columns: repeat(1, 1fr); + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; } -} -.tsd-index-panel .tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-flag { - display: inline-block; - padding: 0.25em 0.4em; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 75%; - line-height: 1; - font-weight: normal; -} + .tsd-navigation.settings { + margin: 1rem 0; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } -.tsd-anchor { - position: relative; - top: -100px; -} + .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; + } -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - display: flex; - align-items: center; - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } -.tsd-navigation.settings { - margin: 1rem 0; -} -.tsd-navigation > a, -.tsd-navigation .tsd-accordion-summary { - width: calc(100% - 0.25rem); - display: flex; - align-items: center; -} -.tsd-navigation a, -.tsd-navigation summary > span, -.tsd-page-navigation a { - display: flex; - width: calc(100% - 0.25rem); - align-items: center; - padding: 0.25rem; - color: var(--color-text); - text-decoration: none; - box-sizing: border-box; -} -.tsd-navigation a.current, -.tsd-page-navigation a.current { - background: var(--color-active-menu-item); -} -.tsd-navigation a:hover, -.tsd-page-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul, -.tsd-page-navigation ul { - margin-top: 0; - margin-bottom: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li, -.tsd-page-navigation li { - padding: 0; - max-width: 100%; -} -.tsd-navigation .tsd-nav-link { - display: none; -} -.tsd-nested-navigation { - margin-left: 3rem; -} -.tsd-nested-navigation > li > details { - margin-left: -1.5rem; -} -.tsd-small-nested-navigation { - margin-left: 1.5rem; -} -.tsd-small-nested-navigation > li > details { - 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; -} - -#tsd-sidebar-links a { - margin-top: 0; - margin-bottom: 0.5rem; - line-height: 1.25rem; -} -#tsd-sidebar-links a:last-of-type { - margin-bottom: 0; -} - -a.tsd-index-link { - padding: 0.25rem 0 !important; - font-size: 1rem; - line-height: 1.25rem; - display: inline-flex; - align-items: center; - color: var(--color-text); -} -.tsd-accordion-summary { - list-style-type: none; /* hide marker on non-safari */ - outline: none; /* broken on safari, so just hide it */ -} -.tsd-accordion-summary::-webkit-details-marker { - display: none; /* hide marker on safari */ -} -.tsd-accordion-summary, -.tsd-accordion-summary a { - -moz-user-select: none; - -webkit-user-select: none; - -ms-user-select: none; - user-select: none; - - cursor: pointer; -} -.tsd-accordion-summary a { - width: calc(100% - 1.5rem); -} -.tsd-accordion-summary > * { - margin-top: 0; - margin-bottom: 0; - padding-top: 0; - padding-bottom: 0; -} -.tsd-accordion .tsd-accordion-summary > svg { - margin-left: 0.25rem; - vertical-align: text-top; -} -.tsd-index-content > :not(:first-child) { - margin-top: 0.75rem; -} -.tsd-index-heading { - margin-top: 1.5rem; - margin-bottom: 0.75rem; -} - -.tsd-no-select { - -webkit-user-select: none; - -moz-user-select: none; - -ms-user-select: none; - user-select: none; -} -.tsd-kind-icon { - margin-right: 0.5rem; - width: 1.25rem; - height: 1.25rem; - min-width: 1.25rem; - min-height: 1.25rem; -} -.tsd-signature > .tsd-kind-icon { - margin-right: 0.8rem; -} - -.tsd-panel { - margin-bottom: 2.5rem; -} -.tsd-panel.tsd-member { - margin-bottom: 4rem; -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5rem -1.5rem 0.75rem -1.5rem; - padding: 0 1.5rem 0.75rem 1.5rem; -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: none; -} - -.tsd-panel-group { - margin: 2rem 0; -} -.tsd-panel-group.tsd-index-group { - margin: 2rem 0; -} -.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; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 2.5rem; - height: 100%; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title, -#tsd-toolbar-links a { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - background-color: var(--color-background); - line-height: initial; - padding: 4px; -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-background-secondary); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current:not(.no-results), -#tsd-search .results li:hover:not(.no-results) { - background-color: var(--color-accent); -} -#tsd-search .results a { - display: flex; - align-items: center; - padding: 0.25rem; - box-sizing: border-box; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-accent); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title, -#tsd-search.has-focus #tsd-toolbar-links a { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -#tsd-toolbar-links { - position: absolute; - top: 0; - right: 2rem; - height: 100%; - display: flex; - align-items: center; - justify-content: flex-end; -} -#tsd-toolbar-links a { - margin-left: 1.5rem; -} -#tsd-toolbar-links a:hover { - text-decoration: underline; -} - -.tsd-signature { - margin: 0 0 1rem 0; - padding: 1rem 0.5rem; - border: 1px solid var(--color-accent); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} - -.tsd-signature-keyword { - color: var(--color-ts-keyword); - font-weight: normal; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - list-style-type: none; -} -.tsd-signatures .tsd-signature { - margin: 0; - border-color: var(--color-accent); - border-width: 1px 0; - transition: background-color 0.1s; -} -.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; -} - -ul.tsd-parameter-list, -ul.tsd-type-parameter-list { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameter-list > li.tsd-parameter-signature, -ul.tsd-type-parameter-list > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameter-list h5, -ul.tsd-type-parameter-list h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -.tsd-sources { - margin-top: 1rem; - font-size: 0.875em; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: sticky; - z-index: 1; - top: 0; - left: 0; - width: 100%; - color: var(--color-text); - background: var(--color-background-secondary); - border-bottom: 1px var(--color-accent) solid; - transition: transform 0.3s ease-in-out; -} -.tsd-page-toolbar a { - color: var(--color-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .tsd-toolbar-contents { - display: flex; - justify-content: space-between; - height: 2.5rem; - margin: 0 auto; -} -.tsd-page-toolbar .table-cell { - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} -.tsd-page-toolbar .tsd-toolbar-icon { - box-sizing: border-box; - line-height: 0; - padding: 12px 0; -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: - opacity 0.1s, - background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-accent); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + .tsd-accordion .tsd-accordion-summary > svg { + margin-left: 0.25rem; + vertical-align: text-top; + } + /* + We need to be careful to target the arrow indicating whether the accordion + is open, but not any other SVGs included in the details element. +*/ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h1 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h2 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h3 > svg:first-child, + .tsd-accordion:not([open]) > .tsd-accordion-summary > h4 > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-heading { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + } -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } -img { - max-width: 100%; -} + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } -.tsd-anchor-icon { - display: inline-flex; - align-items: center; - margin-left: 0.5rem; - vertical-align: middle; - color: var(--color-text); -} + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } -.tsd-anchor-icon svg { - width: 1em; - height: 1em; - visibility: hidden; -} + #tsd-search { + transition: background-color 0.2s; + } + #tsd-search .title { + position: relative; + z-index: 2; + } + #tsd-search .field { + position: absolute; + left: 0; + top: 0; + right: 2.5rem; + height: 100%; + } + #tsd-search .field input { + box-sizing: border-box; + position: relative; + top: -50px; + z-index: 1; + width: 100%; + padding: 0 10px; + opacity: 0; + outline: 0; + border: 0; + background: transparent; + color: var(--color-text); + } + #tsd-search .field label { + position: absolute; + overflow: hidden; + right: -40px; + } + #tsd-search .field input, + #tsd-search .title, + #tsd-toolbar-links a { + transition: opacity 0.2s; + } + #tsd-search .results { + position: absolute; + visibility: hidden; + top: 40px; + width: 100%; + margin: 0; + padding: 0; + list-style: none; + box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); + } + #tsd-search .results li { + background-color: var(--color-background); + line-height: initial; + padding: 4px; + } + #tsd-search .results li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search .results li.state { + display: none; + } + #tsd-search .results li.current:not(.no-results), + #tsd-search .results li:hover:not(.no-results) { + background-color: var(--color-accent); + } + #tsd-search .results a { + display: flex; + align-items: center; + padding: 0.25rem; + box-sizing: border-box; + } + #tsd-search .results a:before { + top: 10px; + } + #tsd-search .results span.parent { + color: var(--color-text-aside); + font-weight: normal; + } + #tsd-search.has-focus { + background-color: var(--color-accent); + } + #tsd-search.has-focus .field input { + top: 0; + opacity: 1; + } + #tsd-search.has-focus .title, + #tsd-search.has-focus #tsd-toolbar-links a { + z-index: 0; + opacity: 0; + } + #tsd-search.has-focus .results { + visibility: visible; + } + #tsd-search.loading .results li.state.loading { + display: block; + } + #tsd-search.failure .results li.state.failure { + display: block; + } -.tsd-anchor-link:hover > .tsd-anchor-icon svg { - visibility: visible; -} + #tsd-toolbar-links { + position: absolute; + top: 0; + right: 2rem; + height: 100%; + display: flex; + align-items: center; + justify-content: flex-end; + } + #tsd-toolbar-links a { + margin-left: 1.5rem; + } + #tsd-toolbar-links a:hover { + text-decoration: underline; + } -.deprecated { - text-decoration: line-through !important; -} + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } -.warning { - padding: 1rem; - color: var(--color-warning-text); - background: var(--color-background-warning); -} + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } -.tsd-kind-project { - color: var(--color-ts-project); -} -.tsd-kind-module { - color: var(--color-ts-module); -} -.tsd-kind-namespace { - color: var(--color-ts-namespace); -} -.tsd-kind-enum { - color: var(--color-ts-enum); -} -.tsd-kind-enum-member { - color: var(--color-ts-enum-member); -} -.tsd-kind-variable { - color: var(--color-ts-variable); -} -.tsd-kind-function { - color: var(--color-ts-function); -} -.tsd-kind-class { - color: var(--color-ts-class); -} -.tsd-kind-interface { - color: var(--color-ts-interface); -} -.tsd-kind-constructor { - color: var(--color-ts-constructor); -} -.tsd-kind-property { - color: var(--color-ts-property); -} -.tsd-kind-method { - color: var(--color-ts-method); -} -.tsd-kind-reference { - color: var(--color-ts-reference); -} -.tsd-kind-call-signature { - color: var(--color-ts-call-signature); -} -.tsd-kind-index-signature { - color: var(--color-ts-index-signature); -} -.tsd-kind-constructor-signature { - color: var(--color-ts-constructor-signature); -} -.tsd-kind-parameter { - color: var(--color-ts-parameter); -} -.tsd-kind-type-parameter { - color: var(--color-ts-type-parameter); -} -.tsd-kind-accessor { - color: var(--color-ts-accessor); -} -.tsd-kind-get-signature { - color: var(--color-ts-get-signature); -} -.tsd-kind-set-signature { - color: var(--color-ts-set-signature); -} -.tsd-kind-type-alias { - color: var(--color-ts-type-alias); -} + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } -/* if we have a kind icon, don't color the text by kind */ -.tsd-kind-icon ~ span { - color: var(--color-text); -} + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } -* { - scrollbar-width: thin; - scrollbar-color: var(--color-accent) var(--color-icon-background); -} + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .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; + } -*::-webkit-scrollbar { - width: 0.75rem; -} + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } -*::-webkit-scrollbar-track { - background: var(--color-icon-background); -} + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: 1px var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + text-decoration: none; + } + .tsd-page-toolbar a.title { + font-weight: bold; + } + .tsd-page-toolbar a.title:hover { + text-decoration: underline; + } + .tsd-page-toolbar .tsd-toolbar-contents { + display: flex; + justify-content: space-between; + height: 2.5rem; + margin: 0 auto; + } + .tsd-page-toolbar .table-cell { + position: relative; + white-space: nowrap; + line-height: 40px; + } + .tsd-page-toolbar .table-cell:first-child { + width: 100%; + } + .tsd-page-toolbar .tsd-toolbar-icon { + box-sizing: border-box; + line-height: 0; + padding: 12px 0; + } -*::-webkit-scrollbar-thumb { - background-color: var(--color-accent); - border-radius: 999rem; - border: 0.25rem solid var(--color-icon-background); -} + .tsd-widget { + display: inline-block; + overflow: hidden; + opacity: 0.8; + height: 40px; + transition: + opacity 0.1s, + background-color 0.2s; + vertical-align: bottom; + cursor: pointer; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget.active { + opacity: 1; + background-color: var(--color-accent); + } + .tsd-widget.no-caption { + width: 40px; + } + .tsd-widget.no-caption:before { + margin: 0; + } -/* mobile */ -@media (max-width: 769px) { .tsd-widget.options, .tsd-widget.menu { - display: inline-block; + display: none; } - - .container-main { - display: flex; + input[type="checkbox"] + .tsd-widget:before { + background-position: -120px 0; + } + input[type="checkbox"]:checked + .tsd-widget:before { + background-position: -160px 0; } - html .col-content { - float: none; + + img { max-width: 100%; - width: 100%; } - html .col-sidebar { - position: fixed !important; - overflow-y: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - padding: 1.5rem 1.5rem 0 0; - width: 75vw; - visibility: hidden; - background-color: var(--color-background); - transform: translate(100%, 0); + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; } - html .col-sidebar > *:last-child { - padding-bottom: 20px; + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; visibility: hidden; } - .to-has-menu .overlay { - animation: fade-in 0.4s; + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg { + visibility: visible; } - .to-has-menu .col-sidebar { - animation: pop-in-from-right 0.4s; + .deprecated { + text-decoration: line-through !important; } - .from-has-menu .overlay { - animation: fade-out 0.4s; + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); } - .from-has-menu .col-sidebar { - animation: pop-out-to-right 0.4s; + .tsd-kind-project { + color: var(--color-ts-project); } - - .has-menu body { - overflow: hidden; + .tsd-kind-module { + color: var(--color-ts-module); } - .has-menu .overlay { - visibility: visible; + .tsd-kind-namespace { + color: var(--color-ts-namespace); } - .has-menu .col-sidebar { - visibility: visible; - transform: translate(0, 0); - display: flex; - flex-direction: column; - gap: 1.5rem; - max-height: 100vh; - padding: 1rem 2rem; + .tsd-kind-enum { + color: var(--color-ts-enum); } - .has-menu .tsd-navigation { - max-height: 100%; + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); } - #tsd-toolbar-links { - display: none; + .tsd-kind-variable { + color: var(--color-ts-variable); } - .tsd-navigation .tsd-nav-link { - display: flex; + .tsd-kind-function { + color: var(--color-ts-function); } -} - -/* one sidebar */ -@media (min-width: 770px) { - .container-main { - display: grid; - grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); - grid-template-areas: "sidebar content"; - margin: 2rem auto; + .tsd-kind-class { + color: var(--color-ts-class); } - - .col-sidebar { - grid-area: sidebar; + .tsd-kind-interface { + color: var(--color-ts-interface); } - .col-content { - grid-area: content; - padding: 0 1rem; + .tsd-kind-constructor { + color: var(--color-ts-constructor); } -} -@media (min-width: 770px) and (max-width: 1399px) { - .col-sidebar { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; - padding-top: 1rem; + .tsd-kind-property { + color: var(--color-ts-property); } - .site-menu { - margin-top: 1rem; + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); } -} -/* two sidebars */ -@media (min-width: 1200px) { - .container-main { - grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax(0, 20rem); - grid-template-areas: "sidebar content toc"; + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); } - .col-sidebar { - display: contents; + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); } - .page-menu { - grid-area: toc; - padding-left: 1rem; + *::-webkit-scrollbar { + width: 0.75rem; } - .site-menu { - grid-area: sidebar; + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); } - .site-menu { - margin-top: 1rem; + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); } - .page-menu, - .site-menu { - max-height: calc(100vh - 2rem - 42px); - overflow: auto; - position: sticky; - top: 42px; + /* mobile */ + @media (max-width: 769px) { + .tsd-widget.options, + .tsd-widget.menu { + display: inline-block; + } + + .container-main { + display: flex; + } + html .col-content { + float: none; + max-width: 100%; + width: 100%; + } + html .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + html .col-sidebar > *:last-child { + padding-bottom: 20px; + } + html .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + #tsd-toolbar-links { + display: none; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + margin: 2rem auto; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + padding-top: 1rem; + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 1rem; + } + + .page-menu, + .site-menu { + max-height: calc(100vh - 2rem - 42px); + overflow: auto; + position: sticky; + top: 42px; + } } } diff --git a/docs/classes/_runtime_data_color_colord.Colord.html b/docs/classes/_runtime_data_color_colord.Colord.html index b38dbf0..9f1ed35 100644 --- a/docs/classes/_runtime_data_color_colord.Colord.html +++ b/docs/classes/_runtime_data_color_colord.Colord.html @@ -1,5 +1,5 @@ -Colord | TyphonJS Runtime Library (FVTT) 0.2.0
-

Class Colord

Constructors

constructor +Colord | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class Colord

Constructors

constructor

Methods

alpha brightness darken @@ -7,48 +7,50 @@ grayscale hue invert -isDark -isEqual -isLight -isValid +isDark +isEqual +isLight +isValid lighten rotate saturate -toHex -toHsl -toHslString -toHsv -toRgb -toRgbString +toHex +toHsl +toHslString +toHsv +toRgb +toRgbString

Properties

rgba -

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

  • brightness(): number

  • Returns the brightness of a color (from 0 to 1). +

Constructors

constructor

Methods

alpha

  • alpha(): number

  • Allows to get or change an alpha channel value.

    +

    Returns number

  • alpha(value: number): Colord

  • Allows to get or change an alpha channel value.

    +

    Parameters

    • value: number

    Returns Colord

brightness

darken

  • darken(amount?): Colord

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

    -

    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.

    -

    Returns boolean

isEqual

  • isEqual(color): boolean

  • Determines whether two values are the same color.

    -

    Parameters

    Returns boolean

isLight

  • isLight(): boolean

  • Same as calling brightness() >= 0.5.

    -

    Returns boolean

isValid

  • isValid(): boolean

  • Returns a boolean indicating whether or not an input has been parsed successfully. +

    Returns number

darken

  • darken(amount?: number): Colord

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

    +

    Parameters

    • Optionalamount: number

    Returns Colord

desaturate

  • desaturate(amount?: number): 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: number): Colord

  • Allows to get or change a hue value.

    +

    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.

    +

    Returns boolean

isEqual

  • isEqual(color: AnyColor | Colord): boolean

  • Determines whether two values are the same color.

    +

    Parameters

    Returns boolean

isLight

  • isLight(): boolean

  • Same as calling brightness() >= 0.5.

    +

    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

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

    Returns boolean

lighten

  • lighten(amount?: number): Colord

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

    +

    Parameters

    • Optionalamount: number

    Returns Colord

rotate

  • rotate(amount?: number): Colord

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

    +

    Parameters

    • Optionalamount: number

    Returns Colord

saturate

  • saturate(amount?: number): 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. +

    Returns string

toHsl

  • toHsl(digits?: number): HslaColor

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

    -

    Parameters

    • Optionaldigits: 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?: number): string

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

    -

    Parameters

    • Optionaldigits: 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?: number): HsvaColor

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

    -

    Parameters

    • Optionaldigits: 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?: number): RgbaColor

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

    -

    Parameters

    • Optionaldigits: 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?: number): 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

    • Optionaldigits: number

    Returns string

Properties

Readonlyrgba

rgba: RgbaColor

Settings

Member Visibility

On This Page

Constructors
Methods
Properties
\ 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 d932e5c..6b4ed29 100644 --- a/docs/classes/_runtime_data_compress.AsyncCompress.html +++ b/docs/classes/_runtime_data_compress.AsyncCompress.html @@ -1,25 +1,25 @@ -AsyncCompress | TyphonJS Runtime Library (FVTT) 0.2.0
-

Class AsyncCompress

Asynchronous streaming GZIP compression

+AsyncCompress | TyphonJS Runtime Library (FVTT) 0.2.0
+

Class AsyncCompress

Asynchronous streaming GZIP compression

Constructors

constructor

Methods

flush push

Properties

ondata ondrain? -queuedSize +queuedSize terminate -

Constructors

constructor

  • new AsyncCompress(opts, cb?): AsyncCompress

  • Creates an asynchronous GZIP stream

    +

Constructors

constructor

Returns AsyncCompress

  • new AsyncCompress(cb?: AsyncFlateStreamHandler): AsyncCompress

  • Creates an asynchronous GZIP stream

    Parameters

    Returns AsyncCompress

    • Methods

    flush

    • flush(): void

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

    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

    push

    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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 c6f6a7f..7730fc0 100644 --- a/docs/classes/_runtime_data_compress.AsyncDecompress.html +++ b/docs/classes/_runtime_data_compress.AsyncDecompress.html @@ -1,19 +1,19 @@ -AsyncDecompress | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncDecompress

    Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression

    +AsyncDecompress | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncDecompress

    Asynchronous streaming GZIP, Zlib, or raw DEFLATE decompression

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? -queuedSize -

    Constructors

    constructor

    Constructors

    constructor

    Returns AsyncDecompress

  • new AsyncDecompress(cb?: AsyncFlateStreamHandler): AsyncDecompress

  • Creates an asynchronous decompression stream

    Parameters

    Returns AsyncDecompress

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed

      -

      Parameters

      Returns AsyncDecompress

    Methods

    push

    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

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file +

    queuedSize

    queuedSize: number

    The number of compressed bytes buffered in the stream

    +

    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 604c6c9..716e00a 100644 --- a/docs/classes/_runtime_data_compress.AsyncDeflate.html +++ b/docs/classes/_runtime_data_compress.AsyncDeflate.html @@ -1,25 +1,25 @@ -AsyncDeflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncDeflate

    Asynchronous streaming DEFLATE compression

    +AsyncDeflate | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncDeflate

    Asynchronous streaming DEFLATE compression

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata ondrain? -queuedSize +queuedSize terminate -

    Constructors

    constructor

    • new AsyncDeflate(opts, cb?): AsyncDeflate

    • Creates an asynchronous DEFLATE stream

      +

    Constructors

    constructor

    Returns AsyncDeflate

  • new AsyncDeflate(cb?: AsyncFlateStreamHandler): AsyncDeflate

  • Creates an asynchronous DEFLATE stream

    Parameters

    Returns AsyncDeflate

    • Methods

    flush

    • flush(): void

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

    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

    push

    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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 7450b82..5846712 100644 --- a/docs/classes/_runtime_data_compress.AsyncGunzip.html +++ b/docs/classes/_runtime_data_compress.AsyncGunzip.html @@ -1,24 +1,24 @@ -AsyncGunzip | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncGunzip

    Asynchronous streaming single or multi-member GZIP decompression

    +AsyncGunzip | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncGunzip

    Asynchronous streaming single or multi-member GZIP decompression

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? onmember? -queuedSize +queuedSize terminate -

    Constructors

    constructor

    • new AsyncGunzip(opts, cb?): AsyncGunzip

    • Creates an asynchronous GUNZIP stream

      +

    Constructors

    constructor

    Returns AsyncGunzip

  • new AsyncGunzip(cb?: AsyncFlateStreamHandler): AsyncGunzip

  • Creates an asynchronous GUNZIP stream

    Parameters

    Returns AsyncGunzip

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be GUNZIPped

      -

      Parameters

      Returns AsyncGunzip

    Methods

    push

    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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 5d597b9..abf5aeb 100644 --- a/docs/classes/_runtime_data_compress.AsyncInflate.html +++ b/docs/classes/_runtime_data_compress.AsyncInflate.html @@ -1,22 +1,22 @@ -AsyncInflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncInflate

    Asynchronous streaming DEFLATE decompression

    +AsyncInflate | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncInflate

    Asynchronous streaming DEFLATE decompression

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? -queuedSize +queuedSize terminate -

    Constructors

    constructor

    • new AsyncInflate(opts, cb?): AsyncInflate

    • Creates an asynchronous DEFLATE decompression stream

      +

    Constructors

    constructor

    Returns AsyncInflate

  • new AsyncInflate(cb?: AsyncFlateStreamHandler): AsyncInflate

  • Creates an asynchronous DEFLATE decompression stream

    Parameters

    Returns AsyncInflate

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be inflated

      -

      Parameters

      Returns AsyncInflate

    Methods

    push

    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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 0b40515..d54841a 100644 --- a/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html +++ b/docs/classes/_runtime_data_compress.AsyncUnzipInflate.html @@ -1,5 +1,5 @@ -AsyncUnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncUnzipInflate

    Asynchronous streaming DEFLATE decompression for ZIP archives

    +AsyncUnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncUnzipInflate

    Asynchronous streaming DEFLATE decompression for ZIP archives

    @@ -15,11 +15,11 @@

    Properties

    ondata terminate compression -

    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.

        +

    Constructors

    constructor

    • new AsyncUnzipInflate(_: string, sz?: number): AsyncUnzipInflate

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

      +

      Parameters

      • _: string
      • Optionalsz: number

      Returns AsyncUnzipInflate

    Methods

    push

    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.

    -

    Staticcompression

    compression: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ 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 82747f0..4500090 100644 --- a/docs/classes/_runtime_data_compress.AsyncUnzlib.html +++ b/docs/classes/_runtime_data_compress.AsyncUnzlib.html @@ -1,22 +1,22 @@ -AsyncUnzlib | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncUnzlib

    Asynchronous streaming Zlib decompression

    +AsyncUnzlib | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncUnzlib

    Asynchronous streaming Zlib decompression

    Constructors

    constructor

    Methods

    push

    Properties

    ondata ondrain? -queuedSize +queuedSize terminate -

    Constructors

    constructor

    • new AsyncUnzlib(opts, cb?): AsyncUnzlib

    • Creates an asynchronous Zlib decompression stream

      +

    Constructors

    constructor

    Returns AsyncUnzlib

  • new AsyncUnzlib(cb?: AsyncFlateStreamHandler): AsyncUnzlib

  • Creates an asynchronous Zlib decompression stream

    Parameters

    Returns AsyncUnzlib

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed from Zlib

      -

      Parameters

      Returns AsyncUnzlib

    Methods

    push

    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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 288a057..396c54c 100644 --- a/docs/classes/_runtime_data_compress.AsyncZipDeflate.html +++ b/docs/classes/_runtime_data_compress.AsyncZipDeflate.html @@ -1,5 +1,5 @@ -AsyncZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncZipDeflate

    Asynchronous streaming DEFLATE compression for ZIP archives

    +AsyncZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncZipDeflate

    Asynchronous streaming DEFLATE compression for ZIP archives

    @@ -25,11 +25,11 @@
    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: string, opts?: DeflateOptions): AsyncZipDeflate

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

      Parameters

      • filename: string

        The filename to associate with this data stream

      • 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

      Returns AsyncZipDeflate

    Methods

    process

    push

    Properties

    Optionalattrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, @@ -55,7 +55,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.

    -

    Optionalextra

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

    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 @@ -63,10 +63,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.

    -

    Optionalmtime

    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)

    @@ -87,4 +87,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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 df296b4..4ba5f8d 100644 --- a/docs/classes/_runtime_data_compress.AsyncZlib.html +++ b/docs/classes/_runtime_data_compress.AsyncZlib.html @@ -1,25 +1,25 @@ -AsyncZlib | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class AsyncZlib

    Asynchronous streaming Zlib compression

    +AsyncZlib | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class AsyncZlib

    Asynchronous streaming Zlib compression

    Constructors

    constructor

    Methods

    flush push

    Properties

    ondata ondrain? -queuedSize +queuedSize terminate -

    Constructors

    constructor

    • new AsyncZlib(opts, cb?): AsyncZlib

    • Creates an asynchronous Zlib stream

      +

    Constructors

    constructor

    Returns AsyncZlib

  • new AsyncZlib(cb?: AsyncFlateStreamHandler): AsyncZlib

  • Creates an asynchronous Zlib stream

    Parameters

    Returns AsyncZlib

    • Methods

    flush

    • flush(): void

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

    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

    push

    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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 bbdb0e2..3a50ad5 100644 --- a/docs/classes/_runtime_data_compress.Compress.html +++ b/docs/classes/_runtime_data_compress.Compress.html @@ -1,18 +1,18 @@ -Compress | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Compress

    Streaming GZIP compression

    +Compress | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Compress

  • new Compress(cb?: FlateStreamHandler): Compress

  • Creates a GZIP stream

    Parameters

    Returns Compress

    • Methods

    flush

    • flush(): void

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

    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

    push

    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 +

    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 4e9e13d..3a7a26b 100644 --- a/docs/classes/_runtime_data_compress.DecodeUTF8.html +++ b/docs/classes/_runtime_data_compress.DecodeUTF8.html @@ -1,12 +1,12 @@ -DecodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class DecodeUTF8

    Streaming UTF-8 decoding

    +DecodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class DecodeUTF8

    Streaming UTF-8 decoding

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    • new DecodeUTF8(cb?): DecodeUTF8

    • Creates a UTF-8 decoding stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

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

      -

      Parameters

      Returns DecodeUTF8

    Methods

    push

    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 +

    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 3419c2e..5bf5839 100644 --- a/docs/classes/_runtime_data_compress.Decompress.html +++ b/docs/classes/_runtime_data_compress.Decompress.html @@ -1,15 +1,15 @@ -Decompress | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Decompress

    Streaming GZIP, Zlib, or raw DEFLATE decompression

    +Decompress | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Decompress

  • new Decompress(cb?: FlateStreamHandler): Decompress

  • Creates a decompression stream

    Parameters

    Returns Decompress

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be decompressed

      -

      Parameters

      Returns Decompress

    Methods

    push

    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 +

    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 423aaf9..0355207 100644 --- a/docs/classes/_runtime_data_compress.Deflate.html +++ b/docs/classes/_runtime_data_compress.Deflate.html @@ -1,18 +1,18 @@ -Deflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Deflate

    Streaming DEFLATE compression

    +Deflate | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Deflate

  • new Deflate(cb?: FlateStreamHandler): Deflate

  • Creates a DEFLATE stream

    Parameters

    Returns Deflate

    • Methods

    flush

    • flush(): void

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

    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

    push

    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 +

    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 94fc55b..87911ba 100644 --- a/docs/classes/_runtime_data_compress.EncodeUTF8.html +++ b/docs/classes/_runtime_data_compress.EncodeUTF8.html @@ -1,12 +1,12 @@ -EncodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class EncodeUTF8

    Streaming UTF-8 encoding

    +EncodeUTF8 | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class EncodeUTF8

    Streaming UTF-8 encoding

    Constructors

    constructor

    Methods

    push

    Properties

    ondata -

    Constructors

    constructor

    • new EncodeUTF8(cb?): EncodeUTF8

    • Creates a UTF-8 decoding stream

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be encoded to UTF-8

      +

    Returns EncodeUTF8

    Methods

    push

    • push(chunk: string, final?: boolean): void

    • Pushes a chunk to be encoded to UTF-8

      Parameters

      • chunk: string

        The string data to push

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

    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 87a3e43..4b2ffaf 100644 --- a/docs/classes/_runtime_data_compress.Gunzip.html +++ b/docs/classes/_runtime_data_compress.Gunzip.html @@ -1,17 +1,17 @@ -Gunzip | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Gunzip

    Streaming single or multi-member GZIP decompression

    +Gunzip | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Gunzip

  • new Gunzip(cb?: FlateStreamHandler): Gunzip

  • Creates a GUNZIP stream

    Parameters

    Returns Gunzip

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be GUNZIPped

      -

      Parameters

      Returns Gunzip

    Methods

    push

    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 +

    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 7de6896..ca0e124 100644 --- a/docs/classes/_runtime_data_compress.Inflate.html +++ b/docs/classes/_runtime_data_compress.Inflate.html @@ -1,15 +1,15 @@ -Inflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Inflate

    Streaming DEFLATE decompression

    +Inflate | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Inflate

  • new Inflate(cb?: FlateStreamHandler): Inflate

  • Creates a DEFLATE decompression stream

    Parameters

    Returns Inflate

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be inflated

      -

      Parameters

      Returns Inflate

    Methods

    push

    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 +

    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 901f54e..49c7ecb 100644 --- a/docs/classes/_runtime_data_compress.Unzip.html +++ b/docs/classes/_runtime_data_compress.Unzip.html @@ -1,16 +1,16 @@ -Unzip | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Unzip

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

    +Unzip | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

      +

    Constructors

    constructor

    Methods

    push

    • push(chunk, final?): any

    • Pushes a chunk to be unzipped

      -

      Parameters

      Returns Unzip

    Methods

    push

    register

    • register(decoder): void

    • Registers a decoder with the stream, allowing for files compressed with +

    Returns any

    register

    • register(decoder: UnzipDecoderConstructor): 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

    On This Page

    Constructors
    Methods
    Properties
    \ 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.UnzipInflate.html b/docs/classes/_runtime_data_compress.UnzipInflate.html index 7e2a603..8af2b45 100644 --- a/docs/classes/_runtime_data_compress.UnzipInflate.html +++ b/docs/classes/_runtime_data_compress.UnzipInflate.html @@ -1,5 +1,5 @@ -UnzipInflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class UnzipInflate

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

    +

    Class UnzipInflate

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

    @@ -15,9 +15,9 @@

    Methods

    push

    Properties

    ondata compression -

    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.

        +

    Constructors

    constructor

    Methods

    push

    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 +

    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 606b8e6..72bff64 100644 --- a/docs/classes/_runtime_data_compress.UnzipPassThrough.html +++ b/docs/classes/_runtime_data_compress.UnzipPassThrough.html @@ -1,5 +1,5 @@ -UnzipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class UnzipPassThrough

    Streaming pass-through decompression for ZIP archives

    +UnzipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class UnzipPassThrough

    Streaming pass-through decompression for ZIP archives

    @@ -14,8 +14,8 @@

    Methods

    push

    Properties

    ondata compression -

    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.

        +

    Constructors

    constructor

    Methods

    push

    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 +

    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 d0dd2b2..8a4219b 100644 --- a/docs/classes/_runtime_data_compress.Unzlib.html +++ b/docs/classes/_runtime_data_compress.Unzlib.html @@ -1,15 +1,15 @@ -Unzlib | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Unzlib

    Streaming Zlib decompression

    +Unzlib | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Unzlib

  • new Unzlib(cb?: FlateStreamHandler): Unzlib

  • Creates a Zlib decompression stream

    Parameters

    Returns Unzlib

    • Methods

    push

    • push(chunk, final?): void

    • Pushes a chunk to be unzlibbed

      -

      Parameters

      Returns Unzlib

    Methods

    push

    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 +

    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 d6c1e43..0f7570b 100644 --- a/docs/classes/_runtime_data_compress.Zip.html +++ b/docs/classes/_runtime_data_compress.Zip.html @@ -1,19 +1,19 @@ -Zip | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Zip

    A zippable archive to which files can incrementally be added

    +Zip | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

      +

    Constructors

    constructor

    Methods

    add

    • add(file): void

    • Adds a file to the ZIP archive

      +

    Returns Zip

    Methods

    add

    • add(file: ZipInputFile): 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. +

    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 +

      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

    On This Page

    Constructors
    Methods
    Properties
    \ 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.ZipDeflate.html b/docs/classes/_runtime_data_compress.ZipDeflate.html index 3b08dc0..a5055c8 100644 --- a/docs/classes/_runtime_data_compress.ZipDeflate.html +++ b/docs/classes/_runtime_data_compress.ZipDeflate.html @@ -1,5 +1,5 @@ -ZipDeflate | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class ZipDeflate

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

    +

    Class ZipDeflate

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

    @@ -25,11 +25,11 @@
    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: string, opts?: DeflateOptions): ZipDeflate

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

      Parameters

      • filename: string

        The filename to associate with this data stream

      • 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

      Returns ZipDeflate

    Methods

    process

    push

    Properties

    Optionalattrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, @@ -55,7 +55,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.

    -

    Optionalextra

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

    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 @@ -63,10 +63,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.

    -

    Optionalmtime

    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)

    @@ -83,4 +83,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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 3a6c446..cba2b38 100644 --- a/docs/classes/_runtime_data_compress.ZipPassThrough.html +++ b/docs/classes/_runtime_data_compress.ZipPassThrough.html @@ -1,5 +1,5 @@ -ZipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class ZipPassThrough

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

    +ZipPassThrough | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class ZipPassThrough

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

    @@ -23,18 +23,18 @@
    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: string): 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

    Protectedprocess

    • process(chunk, final): void

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

    Returns ZipPassThrough

    Methods

    Protectedprocess

    • process(chunk: Uint8Array<ArrayBufferLike>, final: boolean): 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.

      -

      Parameters

    push

    • push(chunk, final?): void

    • Pushes a chunk to be added. If you are subclassing this with a custom +

    Returns void

    push

    • push(chunk: Uint8Array<ArrayBufferLike>, final?: boolean): void

    • Pushes a chunk to be added. If you are subclassing this with a custom compression algorithm, note that you must push data from the source file only, pre-compression.

      -

      Parameters

    Properties

    Optionalattrs

    attrs?: number

    The file's attributes. These are traditionally somewhat complicated and platform-dependent, so using them is scarcely necessary. However, @@ -60,7 +60,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.

    -

    Optionalextra

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

    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 @@ -68,7 +68,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.

    -

    Optionalmtime

    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)

    @@ -85,4 +85,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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 2eceda4..b955f89 100644 --- a/docs/classes/_runtime_data_compress.Zlib.html +++ b/docs/classes/_runtime_data_compress.Zlib.html @@ -1,18 +1,18 @@ -Zlib | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Zlib

    Streaming Zlib compression

    +Zlib | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Returns Zlib

  • new Zlib(cb?: FlateStreamHandler): Zlib

  • Creates a Zlib stream

    Parameters

    Returns Zlib

    • Methods

    flush

    • flush(): void

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

    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

    push

    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 +

    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 924cff0..4558201 100644 --- a/docs/classes/_runtime_data_format_msgpack.Decoder.html +++ b/docs/classes/_runtime_data_format_msgpack.Decoder.html @@ -1,5 +1,5 @@ -Decoder | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Decoder

    +Decoder | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class Decoder

    @@ -7,10 +7,10 @@
    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: 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 +unpackMultiple +

    Constructors

    constructor

    Methods

    decode

    unpack

    unpackMultiple

    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 e7ea670..f2fed66 100644 --- a/docs/classes/_runtime_data_format_msgpack.Encoder.html +++ b/docs/classes/_runtime_data_format_msgpack.Encoder.html @@ -1,5 +1,5 @@ -Encoder | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Encoder

    +Encoder | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class Encoder

    @@ -7,16 +7,16 @@
    Hierarchy
    -
    +

    Constructors

    constructor -

    Methods

    clearSharedData +

    Methods

    clearSharedData decode encode pack unpack -unpackMultiple -useBuffer +unpackMultiple +useBuffer

    Properties

    offset position -

    Constructors

    constructor

    Methods

    clearSharedData

    decode

    encode

    • encode(value, encodeOptions?): Buffer

    • Parameters

      • value: any
      • OptionalencodeOptions: number

      Returns Buffer

    pack

    • pack(value, encodeOptions?): Buffer

    • Parameters

      • value: any
      • OptionalencodeOptions: number

      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

    useBuffer

    Properties

    offset

    offset: number

    position

    position: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    clearSharedData

    decode

    encode

    pack

    unpack

    unpackMultiple

    useBuffer

    Properties

    offset

    offset: number

    position

    position: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ 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 89538f2..3e7ca7a 100644 --- a/docs/classes/_runtime_data_format_msgpack.Packr.html +++ b/docs/classes/_runtime_data_format_msgpack.Packr.html @@ -1,5 +1,5 @@ -Packr | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Packr

    +Packr | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class Packr

    @@ -7,16 +7,16 @@
    Hierarchy
    -
    +

    Constructors

    constructor -

    Methods

    clearSharedData +

    Methods

    clearSharedData decode encode pack unpack -unpackMultiple -useBuffer +unpackMultiple +useBuffer

    Properties

    offset position -

    Constructors

    constructor

    Methods

    clearSharedData

    • clearSharedData(): void

    • Returns void

    decode

    encode

    • encode(value, encodeOptions?): Buffer

    • Parameters

      • value: any
      • OptionalencodeOptions: number

      Returns Buffer

    pack

    • pack(value, encodeOptions?): Buffer

    • Parameters

      • value: any
      • OptionalencodeOptions: number

      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

    useBuffer

    • useBuffer(buffer): void

    • Parameters

      Returns void

    Properties

    offset

    offset: number

    position

    position: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ No newline at end of file +

    Constructors

    constructor

    Methods

    clearSharedData

    • clearSharedData(): void

    • Returns void

    decode

    encode

    pack

    unpack

    unpackMultiple

    useBuffer

    Properties

    offset

    offset: number

    position

    position: number

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties
    \ 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 4378735..3d6ff87 100644 --- a/docs/classes/_runtime_data_format_msgpack.PackrStream.html +++ b/docs/classes/_runtime_data_format_msgpack.PackrStream.html @@ -1,5 +1,5 @@ -PackrStream | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class PackrStream

    +PackrStream | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class PackrStream

    @@ -7,7 +7,7 @@
    Hierarchy
    -
    • Transform
      • PackrStream
    +
    • Transform
      • PackrStream

    Constructors

    constructor

    Methods

    _construct? @@ -18,27 +18,27 @@
    _transform _write _writev? -[asyncDispose] -[asyncIterator] -[captureRejectionSymbol]? -addListener -asIndexedPairs +[asyncDispose] +[asyncIterator] +[captureRejectionSymbol]? +addListener +asIndexedPairs compose cork destroy drop emit end -eventNames +eventNames every filter find -flatMap -forEach -getMaxListeners -isPaused +flatMap +forEach +getMaxListeners +isPaused iterator -listenerCount +listenerCount listeners map off @@ -46,65 +46,65 @@
    once pause pipe -prependListener -prependOnceListener +prependListener +prependOnceListener push -rawListeners +rawListeners read reduce -removeAllListeners -removeListener +removeAllListeners +removeListener resume -setDefaultEncoding -setEncoding -setMaxListeners +setDefaultEncoding +setEncoding +setMaxListeners some take -toArray +toArray uncork unpipe unshift wrap write -addAbortListener +addAbortListener from -fromWeb -getEventListeners -getMaxListeners -isDisturbed -listenerCount +fromWeb +getEventListeners +getMaxListeners +isDisturbed +listenerCount on once -setMaxListeners -toWeb -

    Properties

    allowHalfOpen +setMaxListeners +toWeb +

    Properties

    allowHalfOpen closed destroyed errored readable -readableAborted -readableDidRead -readableEncoding -readableEnded -readableFlowing -readableHighWaterMark -readableLength -readableObjectMode +readableAborted +readableDidRead +readableEncoding +readableEnded +readableFlowing +readableHighWaterMark +readableLength +readableObjectMode writable -writableCorked -writableEnded -writableFinished -writableHighWaterMark -writableLength -writableNeedDrain -writableObjectMode -captureRejections -captureRejectionSymbol -defaultMaxListeners -errorMonitor -

    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]

    • [asyncIterator](): AsyncIterator<any, any, any>

    • Returns AsyncIterator<any, any, any>

    Optional[captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest...args: AnyRest

      Returns void

    addListener

    Constructors

    constructor

    • new PackrStream(
          options?:
              | Options
              | { allowHalfOpen: boolean; emitClose: boolean; highWaterMark: number },
      ): PackrStream

    • Parameters

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

      Returns PackrStream

    Methods

    Optional_construct

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

    • Parameters

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

      Returns void

    _destroy

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

    • Parameters

      Returns void

    _final

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

    • Parameters

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

      Returns void

    _flush

    • _flush(callback: TransformCallback): void

    • Parameters

      • callback: TransformCallback

      Returns void

    _read

    • _read(size: number): void

    • Parameters

      • size: number

      Returns void

    _transform

    • _transform(
          chunk: any,
          encoding: BufferEncoding,
          callback: TransformCallback,
      ): void

    • Parameters

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

      Returns void

    _write

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

    • Parameters

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

      Returns void

    Optional_writev

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

    • Parameters

      • chunks: { chunk: any; encoding: BufferEncoding }[]
      • callback: (error?: Error) => 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]

    • "[asyncIterator]"(): AsyncIterator<any, any, any>

    • Returns AsyncIterator<any, any, any>

    Optional[captureRejectionSymbol]

    • "[captureRejectionSymbol]"<K>(
          error: Error,
          event: string | symbol,
          ...args: AnyRest,
      ): void

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • ...args: AnyRest

      Returns void

    addListener

    • addListener(event: "close", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
        2. @@ -119,132 +119,176 @@
      2. resume
      3. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "drain", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "end", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "finish", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "pause", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "readable", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "resume", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      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 +

      Parameters

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

      Returns this

    asIndexedPairs

    • asIndexedPairs(options?: Pick<ArrayOptions, "signal">): 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

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

      Parameters

      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream of indexed pairs.

      +

      Since

      v17.5.0

      +

    compose

    • compose<T extends ReadableStream>(
          stream:
              | ComposeFnParam
              | T
              | Iterable<T, any, any>
              | AsyncIterable<T, any, any>,
          options?: { signal: AbortSignal },
      ): 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 @@ -253,28 +297,19 @@

      situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._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 +

      Returns void

      Since

      v0.11.2

      +

    destroy

    • destroy(error?: 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

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

      +

    Returns this

    Since

    v8.0.0

    +

    drop

    • drop(limit: number, options?: Pick<ArrayOptions, "signal">): 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.

        -
      • 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!'.
      import fs from '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 +

    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Readable

    a stream with limit chunks dropped from the start.

    +

    Since

    v17.5.0

    +

    emit

    • emit(event: "close"): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • emit(event: "data", chunk: any): boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • emit(event: "drain"): boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • emit(event: "end"): boolean

    • Parameters

      • event: "end"

      Returns boolean

    • emit(event: "error", err: Error): boolean

    • Parameters

      Returns boolean

    • emit(event: "finish"): boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • emit(event: "pause"): boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • emit(event: "pipe", src: Readable): boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • emit(event: "readable"): boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • emit(event: "resume"): boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • emit(event: "unpipe", src: Readable): boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • emit(event: string | symbol, ...args: any[]): boolean

    • Parameters

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

      Returns boolean

    end

    • end(cb?: () => void): 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.

      @@ -282,56 +317,50 @@ 
      // Write 'hello, ' and then end with 'world!'.
      import fs from '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}, -{TypedArray} or {DataView}. 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!'.
      import fs from '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}, -{TypedArray} or {DataView}. 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 +

      Parameters

      • Optionalcb: () => void

      Returns this

      Since

      v0.9.4

      +
    • end(chunk: any, cb?: () => void): this

    • Parameters

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

      Returns this

    • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): this

    • Parameters

      • chunk: any
      • Optionalencoding: BufferEncoding
      • Optionalcb: () => void

      Returns this

    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

      -

    every

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

    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

      Returns (string | symbol)[]

      Since

      v6.0.0

      +

    every

    • every(
          fn: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): 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: 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 +

      Parameters

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

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

        +
      • 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: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): 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: 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 +

      Parameters

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

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

        +
      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream filtered with the predicate fn.

      +

      Since

      v17.4.0, v16.14.0

      +

    find

    • find<T>(
          fn: (data: any, options?: Pick<ArrayOptions, "signal">) => data is T,
          options?: ArrayOptions,
      ): 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: any, options?: Pick<ArrayOptions, "signal">) => data is T

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

        +
      • 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: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): Promise<any>

    • 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: 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, +

      Parameters

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

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

        +
      • Optionaloptions: ArrayOptions

      Returns Promise<any>

      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: 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 +

      Since

      v17.5.0

      +

    flatMap

    • flatMap(
          fn: (data: any, options?: Pick<ArrayOptions, "signal">) => any,
          options?: ArrayOptions,
      ): 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: 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. +

      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.

        +
      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream flat-mapped with the function fn.

      +

      Since

      v17.5.0

      +

    forEach

    • forEach(
          fn: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => void | Promise<void>,
          options?: ArrayOptions,
      ): 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. In addition, a forEach iteration can only be stopped by having passed a signal option @@ -339,59 +368,59 @@

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

      -

    isPaused

    • isPaused(): boolean

    • The readable.isPaused() method returns the current operating state of the Readable. +

      Parameters

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

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

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

      +

    isPaused

    • isPaused(): boolean

    • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.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

      -

    iterator

    • iterator(options?): AsyncIterator<any, any, any>

    • The iterator created by this method gives users the option to cancel the destruction +

      Returns boolean

      Since

      v0.11.14

      +

    iterator

    • iterator(options?: { destroyOnReturn?: boolean }): AsyncIterator<any, any, 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

      • Optionaloptions: {
            destroyOnReturn?: boolean;
        }
        • OptionaldestroyOnReturn?: 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 AsyncIterator<any, any, any>

          Since

          v16.3.0

          -

    listenerCount

    • listenerCount<K>(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. +

    Returns AsyncIterator<any, any, any>

    Since

    v16.3.0

    +

    listenerCount

    • listenerCount<K>(eventName: string | symbol, listener?: Function): 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.

      -

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

        +

        Type Parameters

        • K

        Parameters

        • eventName: string | symbol

          The name of the event being listened for

        • Optionallistener: Function

          The event handler function

          -

        Returns number

        Since

        v3.2.0

        -

    listeners

    • listeners<K>(eventName): Function[]

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

      +

    Returns number

    Since

    v3.2.0

    +

    listeners

    • listeners<K>(eventName: string | symbol): 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] ]
      -

      Type Parameters

      • K

      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. +

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

      +

    map

    • map(
          fn: (data: any, options?: Pick<ArrayOptions, "signal">) => any,
          options?: ArrayOptions,
      ): 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: 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<K>(eventName, listener): this

    • Alias for emitter.removeListener().

      -

      Type Parameters

      • K

      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 +

      Parameters

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

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

        +
      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream mapped with the function fn.

      +

      Since

      v17.4.0, v16.14.0

      +

    off

    • off<K>(eventName: string | symbol, listener: (...args: any[]) => void): this

    • Alias for emitter.removeListener().

      +

      Type Parameters

      • K

      Parameters

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

      Returns this

      Since

      v10.0.0

      +

    on

    • on(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • on(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • on(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • on(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • on(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • on(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • on(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    once

    • once(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • once(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • once(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • once(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • once(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • once(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • once(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

      • event: string | symbol
      • listener: (...args: any[]) => 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);
      });

      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
      • 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<K>(eventName): Function[]

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

      Returns this

      Since

      v0.9.4

      +

    pipe

    • pipe<T extends WritableStream>(destination: T, options?: { end?: boolean }): T

    • Type Parameters

      • T extends WritableStream

      Parameters

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

      Returns T

    prependListener

    • prependListener(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependListener(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • prependListener(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependListener(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • prependListener(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependListener(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • prependListener(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    prependOnceListener

    • prependOnceListener(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependOnceListener(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • prependOnceListener(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependOnceListener(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • prependOnceListener(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependOnceListener(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • prependOnceListener(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    push

    • push(chunk: any, encoding?: BufferEncoding): boolean

    • Parameters

      • chunk: any
      • Optionalencoding: BufferEncoding

      Returns boolean

    rawListeners

    • rawListeners<K>(eventName: string | symbol): 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');
      -

      Type Parameters

      • K

      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 +

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

      +

    read

    • read(size?: number): 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 specified using the readable.setEncoding() method or the stream is operating @@ -428,24 +457,34 @@

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

      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 +

    Returns any

    Since

    v0.9.4

    +

    reduce

    • reduce<T = any>(
          fn: (
              previous: any,
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => T,
          initial?: undefined,
          options?: Pick<ArrayOptions, "signal">,
      ): 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: 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(eventName?): 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.

        +
      • 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 = any>(
          fn: (
              previous: T,
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => T,
          initial: T,
          options?: Pick<ArrayOptions, "signal">,
      ): 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: T, data: any, options?: Pick<ArrayOptions, "signal">) => T

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

        +
      • initial: T

        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

      +

    removeAllListeners

    • removeAllListeners(eventName?: string | symbol): 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

      • OptionaleventName: 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 +

      Parameters

      • OptionaleventName: string | symbol

      Returns this

      Since

      v0.1.26

      +

    removeListener

    • removeListener(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • removeListener(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • removeListener(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • removeListener(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • removeListener(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • removeListener(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • removeListener(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

      • event: string | symbol
      • listener: (...args: any[]) => 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:

      @@ -453,11 +492,11 @@

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

      -

      Returns this

      Since

      v0.9.4

      -

    setDefaultEncoding

    • setDefaultEncoding(encoding): this

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

      +

      Returns this

      Since

      v0.9.4

      +

    setDefaultEncoding

    • setDefaultEncoding(encoding: BufferEncoding): 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 +

    Returns this

    Since

    v0.11.15

    +

    setEncoding

    • setEncoding(encoding: BufferEncoding): 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 as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the @@ -470,30 +509,30 @@

      Parameters

      • encoding: BufferEncoding

        The encoding to use.

        -

      Returns this

      Since

      v0.9.4

      -

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are +

    Returns this

    Since

    v0.9.4

    +

    setMaxListeners

    • setMaxListeners(n: number): 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 to Infinity (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

      -

    some

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

    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      +

    some

    • some(
          fn: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): 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: 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

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

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

        +
      • 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: number, options?: Pick<ArrayOptions, "signal">): Readable

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

      Parameters

      • limit: number

        the number of chunks to take from the readable.

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

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

    Returns Readable

    a stream with limit chunks taken.

    +

    Since

    v17.5.0

    +

    toArray

    • toArray(options?: Pick<ArrayOptions, "signal">): 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

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

      +

      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() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event loop phase.

      @@ -507,8 +546,8 @@

      See also: writable.cork().

      -

      Returns void

      Since

      v0.11.2

      -

    unpipe

    • unpipe(destination?): this

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

      Returns void

      Since

      v0.11.2

      +

    unpipe

    • unpipe(destination?: WritableStream): 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 @@ -517,8 +556,8 @@

      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 +

    Returns this

    Since

    v0.9.4

    +

    unshift

    • unshift(chunk: any, encoding?: BufferEncoding): 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 flushed.

      @@ -543,8 +582,8 @@

      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}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

      • 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:stream module API as it is currently defined. (See Compatibility for more +

    Returns void

    Since

    v0.9.11

    +

    wrap

    • wrap(stream: ReadableStream): this

    • Prior to Node.js 0.10, streams did not implement the entire node:stream module 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, the readable.wrap() method can be used to create a Readable stream that uses @@ -556,8 +595,8 @@

      Parameters

      • stream: ReadableStream

        An "old style" readable stream

        -

      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 +

    Returns this

    Since

    v0.9.4

    +

    write

    • write(
          chunk: any,
          encoding?: BufferEncoding,
          cb?: (error: Error) => void,
      ): 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 @@ -591,44 +630,9 @@

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. 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 the highWaterMark 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}, -{TypedArray} or {DataView}. 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.

      +
    • Optionalcb: (error: Error) => 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: any, cb?: (error: Error) => void): boolean

  • Parameters

    • chunk: any
    • Optionalcb: (error: Error) => void

    Returns boolean

    • StaticaddAbortListener

    • addAbortListener(
          signal: AbortSignal,
          resource: (event: Event) => void,
      ): 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 @@ -641,9 +645,9 @@ 

      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.

      +

      Parameters

      Returns Disposable

      Disposable that removes the abort listener.

      +

      Since

      v20.5.0

      +

    Staticfrom

    • from(
          src:
              | string
              | Object
              | ArrayBuffer
              | Promise<any>
              | AsyncGeneratorFunction
              | Iterable<any, any, any>
              | Stream
              | Blob
              | AsyncIterable<any, any, any>,
      ): Duplex

    • A utility method for creating duplex streams.

      • Stream converts writable stream into writable Duplex and readable stream to Duplex.
        • @@ -661,10 +665,10 @@
        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

      -

    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.

      +

      Parameters

      Returns Duplex

      Since

      v16.8.0

      +

    StaticfromWeb

    • fromWeb(
          duplexStream: {
              readable: ReadableStream<any>;
              writable: WritableStream<any>;
          },
          options?: Pick<
              DuplexOptions,
              | "signal"
              | "encoding"
              | "highWaterMark"
              | "objectMode"
              | "decodeStrings"
              | "allowHalfOpen",
          >,
      ): Duplex
    • Experimental

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

      +

      Parameters

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

      Returns Duplex

      Since

      v17.0.0

      +

    StaticgetEventListeners

    • getEventListeners(
          emitter: EventTarget | EventEmitter<DefaultEventMap>,
          name: string | symbol,
      ): 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 @@ -672,8 +676,8 @@ 

      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: EventTarget | EventEmitter<DefaultEventMap>
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      -

    StaticgetMaxListeners

    • getMaxListeners(emitter): number

    • Returns the currently set max amount of listeners.

      +

      Parameters

      • emitter: EventTarget | EventEmitter<DefaultEventMap>
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      +

    StaticgetMaxListeners

    • getMaxListeners(emitter: EventTarget | EventEmitter<DefaultEventMap>): 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 @@ -682,18 +686,18 @@ 

      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

      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 eventName registered on the given emitter.

      +

      Parameters

      Returns number

      Since

      v19.9.0

      +

    StaticisDisturbed

    • isDisturbed(stream: Readable | ReadableStream): boolean

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

      +

      Parameters

      • stream: Readable | ReadableStream

      Returns boolean

      Since

      v16.8.0

      +

    StaticlistenerCount

    • listenerCount(
          emitter: EventEmitter<DefaultEventMap>,
          eventName: string | symbol,
      ): number

    • A class method that returns the number of listeners for the given eventName registered 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<DefaultEventMap>

        The emitter to query

        -
      • eventName: string | symbol

        The event name

        -

      Returns number

      Since

      v0.9.12

      -

      Deprecated

      Since v3.2.0 - Use listenerCount instead.

      -

    Staticon

    • on(emitter, eventName, options?): AsyncIterator<any[], any, 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
+
    • eventName: string | symbol

      The event name

      +

    Returns number

    Since

    v0.9.12

    +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +

    Staticon

    • on(
          emitter: EventEmitter<DefaultEventMap>,
          eventName: string | symbol,
          options?: StaticEventEmitterIteratorOptions,
      ): AsyncIterator<any[], any, 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 @@ -708,9 +712,46 @@ 

      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);
        ee.emit('close');
      });

      for await (const event of on(ee, 'foo', { close: ['close'] })) {
        console.log(event); // prints ['bar'] [42]
      }
      // the loop will exit after 'close' is emitted
      console.log('done'); // prints 'done'
      -

      Parameters

      • emitter: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

      An AsyncIterator that iterates eventName events emitted by the emitter

      -

      Since

      v13.6.0, v12.16.0

      -
    • on(emitter, eventName, options?): AsyncIterator<any[], any, any>

    • Parameters

      • emitter: EventTarget
      • eventName: string
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

    Staticonce

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

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

      Parameters

      • emitter: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

      An AsyncIterator that iterates eventName events emitted by the emitter

      +

      Since

      v13.6.0, v12.16.0

      +
    • on(
          emitter: EventTarget,
          eventName: string,
          options?: StaticEventEmitterIteratorOptions,
      ): AsyncIterator<any[], any, 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());
+
      + +

      Use the close option to specify an array of event names that will end the iteration:

      +
      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);
        ee.emit('close');
      });

      for await (const event of on(ee, 'foo', { close: ['close'] })) {
        console.log(event); // prints ['bar'] [42]
      }
      // the loop will exit after 'close' is emitted
      console.log('done'); // prints 'done'
+
      + +

      Parameters

      • emitter: EventTarget
      • eventName: string
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

      An AsyncIterator that iterates eventName events emitted by the emitter

      +

      Since

      v13.6.0, v12.16.0

      +

    Staticonce

    • once(
          emitter: EventEmitter<DefaultEventMap>,
          eventName: string | symbol,
          options?: StaticEventEmitterOptions,
      ): 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 +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);
      }
+
      + +

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

      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: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

      +
    • once(
          emitter: EventTarget,
          eventName: string,
          options?: StaticEventEmitterOptions,
      ): 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.

      @@ -729,78 +770,78 @@ 
      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: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

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

    • Parameters

      • emitter: EventTarget
      • 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

      • emitter: EventTarget
      • eventName: string
      • Optionaloptions: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

      +

    StaticsetMaxListeners

    • setMaxListeners(
          n?: number,
          ...eventTargets: (EventTarget | EventEmitter<DefaultEventMap>)[],
      ): 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: (EventTarget | EventEmitter<DefaultEventMap>)[]

        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

      • ...eventTargets: (EventTarget | EventEmitter<DefaultEventMap>)[]

        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

        -

      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 +

    Returns void

    Since

    v15.4.0

    +

    StatictoWeb

    • toWeb(
          streamDuplex: Duplex,
      ): { 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> }

      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 existing Duplex stream instance, but must be changed before the 'end' event is emitted.

    -

    Since

    v0.9.4

    +

    Since

    v0.9.4

    Readonlyclosed

    closed: boolean

    Is true after 'close' has been emitted.

    -

    Since

    v18.0.0

    +

    Since

    v18.0.0

    destroyed

    destroyed: boolean

    Is true after readable.destroy() has been called.

    -

    Since

    v8.0.0

    +

    Since

    v8.0.0

    Readonlyerrored

    errored: Error

    Returns error if the stream has been destroyed with an error.

    -

    Since

    v18.0.0

    +

    Since

    v18.0.0

    readable

    readable: boolean

    Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

    -

    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 encoding property can be set using the 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

    -

    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 +

    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 encoding property can be set using the 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

    +

    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

    -

    ReadonlyreadableObjectMode

    readableObjectMode: boolean

    Getter for the property objectMode of a given Readable stream.

    -

    Since

    v12.3.0

    +

    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 +

    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 +

    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 +

    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

    +

    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 ReadonlycaptureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    +

    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 +

    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.defaultMaxListeners property @@ -824,9 +865,9 @@

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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 61a02aa..287f145 100644 --- a/docs/classes/_runtime_data_format_msgpack.Unpackr.html +++ b/docs/classes/_runtime_data_format_msgpack.Unpackr.html @@ -1,5 +1,5 @@ -Unpackr | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Unpackr

    +Unpackr | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class Unpackr

    @@ -7,10 +7,10 @@
    Hierarchy
    -
    +

    Constructors

    constructor

    Methods

    decode unpack -unpackMultiple -

    Constructors

    constructor

    Methods

    decode

    • decode(messagePack, options?): any

    • Parameters

      Returns any

    unpack

    • unpack(messagePack, options?): 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 +unpackMultiple +

    Constructors

    constructor

    Methods

    decode

    unpack

    unpackMultiple

    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 573eb51..4f707b8 100644 --- a/docs/classes/_runtime_data_format_msgpack.UnpackrStream.html +++ b/docs/classes/_runtime_data_format_msgpack.UnpackrStream.html @@ -1,5 +1,5 @@ -UnpackrStream | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class UnpackrStream

    +UnpackrStream | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class UnpackrStream

    @@ -7,7 +7,7 @@
    Hierarchy
    -
    • Transform
      • UnpackrStream
    +
    • Transform
      • UnpackrStream

    Constructors

    constructor

    Methods

    _construct? @@ -18,27 +18,27 @@
    _transform _write _writev? -[asyncDispose] -[asyncIterator] -[captureRejectionSymbol]? -addListener -asIndexedPairs +[asyncDispose] +[asyncIterator] +[captureRejectionSymbol]? +addListener +asIndexedPairs compose cork destroy drop emit end -eventNames +eventNames every filter find -flatMap -forEach -getMaxListeners -isPaused +flatMap +forEach +getMaxListeners +isPaused iterator -listenerCount +listenerCount listeners map off @@ -46,65 +46,65 @@
    once pause pipe -prependListener -prependOnceListener +prependListener +prependOnceListener push -rawListeners +rawListeners read reduce -removeAllListeners -removeListener +removeAllListeners +removeListener resume -setDefaultEncoding -setEncoding -setMaxListeners +setDefaultEncoding +setEncoding +setMaxListeners some take -toArray +toArray uncork unpipe unshift wrap write -addAbortListener +addAbortListener from -fromWeb -getEventListeners -getMaxListeners -isDisturbed -listenerCount +fromWeb +getEventListeners +getMaxListeners +isDisturbed +listenerCount on once -setMaxListeners -toWeb -

    Properties

    allowHalfOpen +setMaxListeners +toWeb +

    Properties

    allowHalfOpen closed destroyed errored readable -readableAborted -readableDidRead -readableEncoding -readableEnded -readableFlowing -readableHighWaterMark -readableLength -readableObjectMode +readableAborted +readableDidRead +readableEncoding +readableEnded +readableFlowing +readableHighWaterMark +readableLength +readableObjectMode writable -writableCorked -writableEnded -writableFinished -writableHighWaterMark -writableLength -writableNeedDrain -writableObjectMode -captureRejections -captureRejectionSymbol -defaultMaxListeners -errorMonitor -

    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]

    • [asyncIterator](): AsyncIterator<any, any, any>

    • Returns AsyncIterator<any, any, any>

    Optional[captureRejectionSymbol]

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

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • Rest...args: AnyRest

      Returns void

    addListener

    Constructors

    constructor

    • new UnpackrStream(
          options?:
              | Options
              | { allowHalfOpen: boolean; emitClose: boolean; highWaterMark: number },
      ): UnpackrStream

    • Parameters

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

      Returns UnpackrStream

    Methods

    Optional_construct

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

    • Parameters

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

      Returns void

    _destroy

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

    • Parameters

      Returns void

    _final

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

    • Parameters

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

      Returns void

    _flush

    • _flush(callback: TransformCallback): void

    • Parameters

      • callback: TransformCallback

      Returns void

    _read

    • _read(size: number): void

    • Parameters

      • size: number

      Returns void

    _transform

    • _transform(
          chunk: any,
          encoding: BufferEncoding,
          callback: TransformCallback,
      ): void

    • Parameters

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

      Returns void

    _write

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

    • Parameters

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

      Returns void

    Optional_writev

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

    • Parameters

      • chunks: { chunk: any; encoding: BufferEncoding }[]
      • callback: (error?: Error) => 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]

    • "[asyncIterator]"(): AsyncIterator<any, any, any>

    • Returns AsyncIterator<any, any, any>

    Optional[captureRejectionSymbol]

    • "[captureRejectionSymbol]"<K>(
          error: Error,
          event: string | symbol,
          ...args: AnyRest,
      ): void

    • Type Parameters

      • K

      Parameters

      • error: Error
      • event: string | symbol
      • ...args: AnyRest

      Returns void

    addListener

    • addListener(event: "close", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
        2. @@ -119,132 +119,176 @@
      2. resume
      3. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            • chunk: any

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "drain", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "end", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "finish", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "pause", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "readable", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

    • addListener(event: "resume", listener: () => void): this

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      Parameters

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

          • Parameters

            • src: Readable

            Returns void

      Returns this

    • addListener(event, listener): this

    • Event emitter +

      Parameters

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

      Returns this

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

    • Event emitter The defined events on documents including:

      1. close
      2. data
        3. +
      3. drain
      4. end
      5. error
        6. +
      6. finish
      7. pause
        8. +
      8. pipe
      9. readable
      10. resume
        11. +
      11. unpipe
      -

      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 +

      Parameters

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

      Returns this

    asIndexedPairs

    • asIndexedPairs(options?: Pick<ArrayOptions, "signal">): 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

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

      Parameters

      • Optionaloptions: Pick<ArrayOptions, "signal">

      Returns Readable

      a stream of indexed pairs.

      +

      Since

      v17.5.0

      +

    compose

    • compose<T extends ReadableStream>(
          stream:
              | ComposeFnParam
              | T
              | Iterable<T, any, any>
              | AsyncIterable<T, any, any>,
          options?: { signal: AbortSignal },
      ): 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 @@ -253,28 +297,19 @@

      situation where data is being buffered while waiting for the first small chunk to be processed. However, use of writable.cork() without implementing writable._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 +

      Returns void

      Since

      v0.11.2

      +

    destroy

    • destroy(error?: 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

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

      +

    Returns this

    Since

    v8.0.0

    +

    drop

    • drop(limit: number, options?: Pick<ArrayOptions, "signal">): 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.

        -
      • 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!'.
      import fs from '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 +

    • Optionaloptions: Pick<ArrayOptions, "signal">

    Returns Readable

    a stream with limit chunks dropped from the start.

    +

    Since

    v17.5.0

    +

    emit

    • emit(event: "close"): boolean

    • Parameters

      • event: "close"

      Returns boolean

    • emit(event: "data", chunk: any): boolean

    • Parameters

      • event: "data"
      • chunk: any

      Returns boolean

    • emit(event: "drain"): boolean

    • Parameters

      • event: "drain"

      Returns boolean

    • emit(event: "end"): boolean

    • Parameters

      • event: "end"

      Returns boolean

    • emit(event: "error", err: Error): boolean

    • Parameters

      Returns boolean

    • emit(event: "finish"): boolean

    • Parameters

      • event: "finish"

      Returns boolean

    • emit(event: "pause"): boolean

    • Parameters

      • event: "pause"

      Returns boolean

    • emit(event: "pipe", src: Readable): boolean

    • Parameters

      • event: "pipe"
      • src: Readable

      Returns boolean

    • emit(event: "readable"): boolean

    • Parameters

      • event: "readable"

      Returns boolean

    • emit(event: "resume"): boolean

    • Parameters

      • event: "resume"

      Returns boolean

    • emit(event: "unpipe", src: Readable): boolean

    • Parameters

      • event: "unpipe"
      • src: Readable

      Returns boolean

    • emit(event: string | symbol, ...args: any[]): boolean

    • Parameters

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

      Returns boolean

    end

    • end(cb?: () => void): 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.

      @@ -282,56 +317,50 @@ 
      // Write 'hello, ' and then end with 'world!'.
      import fs from '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}, -{TypedArray} or {DataView}. 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!'.
      import fs from '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}, -{TypedArray} or {DataView}. 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 +

      Parameters

      • Optionalcb: () => void

      Returns this

      Since

      v0.9.4

      +
    • end(chunk: any, cb?: () => void): this

    • Parameters

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

      Returns this

    • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): this

    • Parameters

      • chunk: any
      • Optionalencoding: BufferEncoding
      • Optionalcb: () => void

      Returns this

    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

      -

    every

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

    • This method is similar to Array.prototype.every and calls fn on each chunk in the stream +

      Returns (string | symbol)[]

      Since

      v6.0.0

      +

    every

    • every(
          fn: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): 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: 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 +

      Parameters

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

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

        +
      • 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: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): 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: 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 +

      Parameters

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

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

        +
      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream filtered with the predicate fn.

      +

      Since

      v17.4.0, v16.14.0

      +

    find

    • find<T>(
          fn: (data: any, options?: Pick<ArrayOptions, "signal">) => data is T,
          options?: ArrayOptions,
      ): 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: any, options?: Pick<ArrayOptions, "signal">) => data is T

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

        +
      • 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: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): Promise<any>

    • 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: 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, +

      Parameters

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

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

        +
      • Optionaloptions: ArrayOptions

      Returns Promise<any>

      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: 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 +

      Since

      v17.5.0

      +

    flatMap

    • flatMap(
          fn: (data: any, options?: Pick<ArrayOptions, "signal">) => any,
          options?: ArrayOptions,
      ): 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: 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. +

      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.

        +
      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream flat-mapped with the function fn.

      +

      Since

      v17.5.0

      +

    forEach

    • forEach(
          fn: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => void | Promise<void>,
          options?: ArrayOptions,
      ): 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. In addition, a forEach iteration can only be stopped by having passed a signal option @@ -339,59 +368,59 @@

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

      -

    isPaused

    • isPaused(): boolean

    • The readable.isPaused() method returns the current operating state of the Readable. +

      Parameters

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

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

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

      +

    isPaused

    • isPaused(): boolean

    • The readable.isPaused() method returns the current operating state of the Readable. This is used primarily by the mechanism that underlies the readable.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

      -

    iterator

    • iterator(options?): AsyncIterator<any, any, any>

    • The iterator created by this method gives users the option to cancel the destruction +

      Returns boolean

      Since

      v0.11.14

      +

    iterator

    • iterator(options?: { destroyOnReturn?: boolean }): AsyncIterator<any, any, 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

      • Optionaloptions: {
            destroyOnReturn?: boolean;
        }
        • OptionaldestroyOnReturn?: 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 AsyncIterator<any, any, any>

          Since

          v16.3.0

          -

    listenerCount

    • listenerCount<K>(eventName, listener?): number

    • Returns the number of listeners listening for the event named eventName. +

    Returns AsyncIterator<any, any, any>

    Since

    v16.3.0

    +

    listenerCount

    • listenerCount<K>(eventName: string | symbol, listener?: Function): 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.

      -

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

        The name of the event being listened for

        +

        Type Parameters

        • K

        Parameters

        • eventName: string | symbol

          The name of the event being listened for

        • Optionallistener: Function

          The event handler function

          -

        Returns number

        Since

        v3.2.0

        -

    listeners

    • listeners<K>(eventName): Function[]

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

      +

    Returns number

    Since

    v3.2.0

    +

    listeners

    • listeners<K>(eventName: string | symbol): 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] ]
      -

      Type Parameters

      • K

      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. +

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v0.1.26

      +

    map

    • map(
          fn: (data: any, options?: Pick<ArrayOptions, "signal">) => any,
          options?: ArrayOptions,
      ): 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: 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<K>(eventName, listener): this

    • Alias for emitter.removeListener().

      -

      Type Parameters

      • K

      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 +

      Parameters

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

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

        +
      • Optionaloptions: ArrayOptions

      Returns Readable

      a stream mapped with the function fn.

      +

      Since

      v17.4.0, v16.14.0

      +

    off

    • off<K>(eventName: string | symbol, listener: (...args: any[]) => void): this

    • Alias for emitter.removeListener().

      +

      Type Parameters

      • K

      Parameters

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

      Returns this

      Since

      v10.0.0

      +

    on

    • on(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • on(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • on(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • on(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • on(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • on(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • on(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    once

    • once(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • once(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • once(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • once(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • once(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • once(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • once(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

      • event: string | symbol
      • listener: (...args: any[]) => 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);
      });

      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
      • 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<K>(eventName): Function[]

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

      Returns this

      Since

      v0.9.4

      +

    pipe

    • pipe<T extends WritableStream>(destination: T, options?: { end?: boolean }): T

    • Type Parameters

      • T extends WritableStream

      Parameters

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

      Returns T

    prependListener

    • prependListener(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependListener(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • prependListener(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependListener(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • prependListener(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependListener(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • prependListener(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    prependOnceListener

    • prependOnceListener(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependOnceListener(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • prependOnceListener(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependOnceListener(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • prependOnceListener(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • prependOnceListener(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • prependOnceListener(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    push

    • push(chunk: any, encoding?: BufferEncoding): boolean

    • Parameters

      • chunk: any
      • Optionalencoding: BufferEncoding

      Returns boolean

    rawListeners

    • rawListeners<K>(eventName: string | symbol): 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');
      -

      Type Parameters

      • K

      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 +

      Type Parameters

      • K

      Parameters

      • eventName: string | symbol

      Returns Function[]

      Since

      v9.4.0

      +

    read

    • read(size?: number): 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 specified using the readable.setEncoding() method or the stream is operating @@ -428,24 +457,34 @@

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

      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 +

    Returns any

    Since

    v0.9.4

    +

    reduce

    • reduce<T = any>(
          fn: (
              previous: any,
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => T,
          initial?: undefined,
          options?: Pick<ArrayOptions, "signal">,
      ): 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: 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(eventName?): 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.

        +
      • 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 = any>(
          fn: (
              previous: T,
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => T,
          initial: T,
          options?: Pick<ArrayOptions, "signal">,
      ): 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: T, data: any, options?: Pick<ArrayOptions, "signal">) => T

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

        +
      • initial: T

        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

      +

    removeAllListeners

    • removeAllListeners(eventName?: string | symbol): 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

      • OptionaleventName: 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 +

      Parameters

      • OptionaleventName: string | symbol

      Returns this

      Since

      v0.1.26

      +

    removeListener

    • removeListener(event: "close", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • removeListener(event: "drain", listener: () => void): this

    • Parameters

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

      Returns this

    • removeListener(event: "end", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • removeListener(event: "finish", listener: () => void): this

    • Parameters

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

      Returns this

    • removeListener(event: "pause", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

    • removeListener(event: "readable", listener: () => void): this

    • Parameters

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

      Returns this

    • removeListener(event: "resume", listener: () => void): this

    • Parameters

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

      Returns this

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

    • Parameters

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

      Returns this

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

    • Parameters

      • event: string | symbol
      • listener: (...args: any[]) => 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:

      @@ -453,11 +492,11 @@

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

      -

      Returns this

      Since

      v0.9.4

      -

    setDefaultEncoding

    • setDefaultEncoding(encoding): this

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

      +

      Returns this

      Since

      v0.9.4

      +

    setDefaultEncoding

    • setDefaultEncoding(encoding: BufferEncoding): 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 +

    Returns this

    Since

    v0.11.15

    +

    setEncoding

    • setEncoding(encoding: BufferEncoding): 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 as Buffer objects. Setting an encoding causes the stream data to be returned as strings of the specified encoding rather than as Buffer objects. For instance, calling readable.setEncoding('utf8') will cause the @@ -470,30 +509,30 @@

      Parameters

      • encoding: BufferEncoding

        The encoding to use.

        -

      Returns this

      Since

      v0.9.4

      -

    setMaxListeners

    • setMaxListeners(n): this

    • By default EventEmitters will print a warning if more than 10 listeners are +

    Returns this

    Since

    v0.9.4

    +

    setMaxListeners

    • setMaxListeners(n: number): 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 to Infinity (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

      -

    some

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

    • This method is similar to Array.prototype.some and calls fn on each chunk in the stream +

      Parameters

      • n: number

      Returns this

      Since

      v0.3.5

      +

    some

    • some(
          fn: (
              data: any,
              options?: Pick<ArrayOptions, "signal">,
          ) => boolean | Promise<boolean>,
          options?: ArrayOptions,
      ): 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: 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

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

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

        +
      • 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: number, options?: Pick<ArrayOptions, "signal">): Readable

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

      Parameters

      • limit: number

        the number of chunks to take from the readable.

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

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

    Returns Readable

    a stream with limit chunks taken.

    +

    Since

    v17.5.0

    +

    toArray

    • toArray(options?: Pick<ArrayOptions, "signal">): 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

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

      +

      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() using process.nextTick(). Doing so allows batching of all writable.write() calls that occur within a given Node.js event loop phase.

      @@ -507,8 +546,8 @@

      See also: writable.cork().

      -

      Returns void

      Since

      v0.11.2

      -

    unpipe

    • unpipe(destination?): this

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

      Returns void

      Since

      v0.11.2

      +

    unpipe

    • unpipe(destination?: WritableStream): 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 @@ -517,8 +556,8 @@

      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 +

    Returns this

    Since

    v0.9.4

    +

    unshift

    • unshift(chunk: any, encoding?: BufferEncoding): 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 flushed.

      @@ -543,8 +582,8 @@

      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}, {TypedArray}, {DataView} or null. For object mode streams, chunk may be any JavaScript value.

      • 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:stream module API as it is currently defined. (See Compatibility for more +

    Returns void

    Since

    v0.9.11

    +

    wrap

    • wrap(stream: ReadableStream): this

    • Prior to Node.js 0.10, streams did not implement the entire node:stream module 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, the readable.wrap() method can be used to create a Readable stream that uses @@ -556,8 +595,8 @@

      Parameters

      • stream: ReadableStream

        An "old style" readable stream

        -

      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 +

    Returns this

    Since

    v0.9.4

    +

    write

    • write(
          chunk: any,
          encoding?: BufferEncoding,
          cb?: (error: Error) => void,
      ): 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 @@ -591,44 +630,9 @@

      Parameters

      • chunk: any

        Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, {TypedArray} or {DataView}. 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 the highWaterMark 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}, -{TypedArray} or {DataView}. 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.

      +
    • Optionalcb: (error: Error) => 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: any, cb?: (error: Error) => void): boolean

  • Parameters

    • chunk: any
    • Optionalcb: (error: Error) => void

    Returns boolean

    • StaticaddAbortListener

    • addAbortListener(
          signal: AbortSignal,
          resource: (event: Event) => void,
      ): 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 @@ -641,9 +645,9 @@ 

      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.

      +

      Parameters

      Returns Disposable

      Disposable that removes the abort listener.

      +

      Since

      v20.5.0

      +

    Staticfrom

    • from(
          src:
              | string
              | Object
              | ArrayBuffer
              | Promise<any>
              | AsyncGeneratorFunction
              | Iterable<any, any, any>
              | Stream
              | Blob
              | AsyncIterable<any, any, any>,
      ): Duplex

    • A utility method for creating duplex streams.

      • Stream converts writable stream into writable Duplex and readable stream to Duplex.
        • @@ -661,10 +665,10 @@
        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

      -

    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.

      +

      Parameters

      Returns Duplex

      Since

      v16.8.0

      +

    StaticfromWeb

    • fromWeb(
          duplexStream: {
              readable: ReadableStream<any>;
              writable: WritableStream<any>;
          },
          options?: Pick<
              DuplexOptions,
              | "signal"
              | "encoding"
              | "highWaterMark"
              | "objectMode"
              | "decodeStrings"
              | "allowHalfOpen",
          >,
      ): Duplex
    • Experimental

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

      +

      Parameters

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

      Returns Duplex

      Since

      v17.0.0

      +

    StaticgetEventListeners

    • getEventListeners(
          emitter: EventTarget | EventEmitter<DefaultEventMap>,
          name: string | symbol,
      ): 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 @@ -672,8 +676,8 @@ 

      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: EventTarget | EventEmitter<DefaultEventMap>
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      -

    StaticgetMaxListeners

    • getMaxListeners(emitter): number

    • Returns the currently set max amount of listeners.

      +

      Parameters

      • emitter: EventTarget | EventEmitter<DefaultEventMap>
      • name: string | symbol

      Returns Function[]

      Since

      v15.2.0, v14.17.0

      +

    StaticgetMaxListeners

    • getMaxListeners(emitter: EventTarget | EventEmitter<DefaultEventMap>): 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 @@ -682,18 +686,18 @@ 

      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

      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 eventName registered on the given emitter.

      +

      Parameters

      Returns number

      Since

      v19.9.0

      +

    StaticisDisturbed

    • isDisturbed(stream: Readable | ReadableStream): boolean

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

      +

      Parameters

      • stream: Readable | ReadableStream

      Returns boolean

      Since

      v16.8.0

      +

    StaticlistenerCount

    • listenerCount(
          emitter: EventEmitter<DefaultEventMap>,
          eventName: string | symbol,
      ): number

    • A class method that returns the number of listeners for the given eventName registered 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<DefaultEventMap>

        The emitter to query

        -
      • eventName: string | symbol

        The event name

        -

      Returns number

      Since

      v0.9.12

      -

      Deprecated

      Since v3.2.0 - Use listenerCount instead.

      -

    Staticon

    • on(emitter, eventName, options?): AsyncIterator<any[], any, 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
+
    • eventName: string | symbol

      The event name

      +

    Returns number

    Since

    v0.9.12

    +

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    +

    Staticon

    • on(
          emitter: EventEmitter<DefaultEventMap>,
          eventName: string | symbol,
          options?: StaticEventEmitterIteratorOptions,
      ): AsyncIterator<any[], any, 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 @@ -708,9 +712,46 @@ 

      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);
        ee.emit('close');
      });

      for await (const event of on(ee, 'foo', { close: ['close'] })) {
        console.log(event); // prints ['bar'] [42]
      }
      // the loop will exit after 'close' is emitted
      console.log('done'); // prints 'done'
      -

      Parameters

      • emitter: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

      An AsyncIterator that iterates eventName events emitted by the emitter

      -

      Since

      v13.6.0, v12.16.0

      -
    • on(emitter, eventName, options?): AsyncIterator<any[], any, any>

    • Parameters

      • emitter: EventTarget
      • eventName: string
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

    Staticonce

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

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

      Parameters

      • emitter: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

      An AsyncIterator that iterates eventName events emitted by the emitter

      +

      Since

      v13.6.0, v12.16.0

      +
    • on(
          emitter: EventTarget,
          eventName: string,
          options?: StaticEventEmitterIteratorOptions,
      ): AsyncIterator<any[], any, 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());
+
      + +

      Use the close option to specify an array of event names that will end the iteration:

      +
      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);
        ee.emit('close');
      });

      for await (const event of on(ee, 'foo', { close: ['close'] })) {
        console.log(event); // prints ['bar'] [42]
      }
      // the loop will exit after 'close' is emitted
      console.log('done'); // prints 'done'
+
      + +

      Parameters

      • emitter: EventTarget
      • eventName: string
      • Optionaloptions: StaticEventEmitterIteratorOptions

      Returns AsyncIterator<any[], any, any>

      An AsyncIterator that iterates eventName events emitted by the emitter

      +

      Since

      v13.6.0, v12.16.0

      +

    Staticonce

    • once(
          emitter: EventEmitter<DefaultEventMap>,
          eventName: string | symbol,
          options?: StaticEventEmitterOptions,
      ): 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 +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);
      }
+
      + +

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

      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: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

      +
    • once(
          emitter: EventTarget,
          eventName: string,
          options?: StaticEventEmitterOptions,
      ): 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.

      @@ -729,78 +770,78 @@ 
      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: EventEmitter<DefaultEventMap>
      • eventName: string | symbol
      • Optionaloptions: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

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

    • Parameters

      • emitter: EventTarget
      • 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

      • emitter: EventTarget
      • eventName: string
      • Optionaloptions: StaticEventEmitterOptions

      Returns Promise<any[]>

      Since

      v11.13.0, v10.16.0

      +

    StaticsetMaxListeners

    • setMaxListeners(
          n?: number,
          ...eventTargets: (EventTarget | EventEmitter<DefaultEventMap>)[],
      ): 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: (EventTarget | EventEmitter<DefaultEventMap>)[]

        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} +

      • ...eventTargets: (EventTarget | EventEmitter<DefaultEventMap>)[]

        Zero or more {EventTarget} or {EventEmitter} instances. If none are specified, n is set as the default max for all newly created {EventTarget} and {EventEmitter} objects.

        -

      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 +

    Returns void

    Since

    v15.4.0

    +

    StatictoWeb

    • toWeb(
          streamDuplex: Duplex,
      ): { 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> }

      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 existing Duplex stream instance, but must be changed before the 'end' event is emitted.

    -

    Since

    v0.9.4

    +

    Since

    v0.9.4

    Readonlyclosed

    closed: boolean

    Is true after 'close' has been emitted.

    -

    Since

    v18.0.0

    +

    Since

    v18.0.0

    destroyed

    destroyed: boolean

    Is true after readable.destroy() has been called.

    -

    Since

    v8.0.0

    +

    Since

    v8.0.0

    Readonlyerrored

    errored: Error

    Returns error if the stream has been destroyed with an error.

    -

    Since

    v18.0.0

    +

    Since

    v18.0.0

    readable

    readable: boolean

    Is true if it is safe to call read, which means the stream has not been destroyed or emitted 'error' or 'end'.

    -

    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 encoding property can be set using the 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

    -

    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 +

    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 encoding property can be set using the 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

    +

    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

    -

    ReadonlyreadableObjectMode

    readableObjectMode: boolean

    Getter for the property objectMode of a given Readable stream.

    -

    Since

    v12.3.0

    +

    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 +

    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 +

    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 +

    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

    +

    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 ReadonlycaptureRejectionSymbol

    captureRejectionSymbol: typeof captureRejectionSymbol

    Value: Symbol.for('nodejs.rejection')

    +

    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 +

    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.defaultMaxListeners property @@ -824,9 +865,9 @@

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

    +

    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

    On This Page

    Constructors
    Methods
    Properties
    \ 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 deleted file mode 100644 index a80aa15..0000000 --- a/docs/classes/_runtime_data_struct_cache_quick_lru.QuickLRU.html +++ /dev/null @@ -1,67 +0,0 @@ -QuickLRU | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class QuickLRU<KeyType, ValueType>

    Type Parameters

    • KeyType
    • ValueType
    -
    - -
    - Implements -
    -     -
    -
    -
    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Accessors

    maxSize -size -

    Methods

    [iterator] -clear -delete -entries -entriesAscending -entriesDescending -forEach -get -has -keys -peek -resize -set -values -

    Properties

    [toStringTag] -[species] -

    Constructors

    constructor

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

    has

    • has(key): boolean

    • Check if an item exists.

      -

      Parameters

      Returns boolean

    keys

    peek

    • peek(key): ValueType

    • Get an item without marking it as recently used.

      -

      Parameters

      Returns ValueType

      The stored item or undefined.

      -

    resize

    • resize(maxSize): void

    • Update the maxSize in-place, discarding items as necessary. Insertion order is mostly preserved, though this is not a strong guarantee.

      -

      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
      • Optionaloptions: {
            maxAge?: number;
        }
        • OptionalmaxAge?: number

      Returns this

      The list instance.

      -

    values

    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 8e45728..f59970b 100644 --- a/docs/classes/_runtime_data_struct_hash_array.HashArray.html +++ b/docs/classes/_runtime_data_struct_hash_array.HashArray.html @@ -1,103 +1,103 @@ -HashArray | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 -

    Accessors

    keyFields +

    Type Parameters

    • T extends object

    Constructors

    constructor +

    Accessors

    keyFields size -sizeFlat +sizeFlat

    Methods

    add clear clone collides entries -entriesFlat +entriesFlat filter -forEach -forEachDeep +forEach +forEachDeep get -getAll -getAsArray -getAt +getAll +getAsArray +getAt has intersection keys remove -removeByKey -removeFirst -removeLast +removeByKey +removeFirst +removeLast values -valuesFlat -

    Properties

    CloneOps -

    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 +valuesFlat +

    Properties

    CloneOps +

    Constructors

    constructor

    • new HashArray<T extends object>(
          keyFields?: string | KeyFields,
          options?: HashArrayOptions<T>,
      ): 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.

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

      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: (T | Iterable<T, any, any>)[]): this

    • Add items or list of items to the HashArray instance.

      +

      Parameters

      • ...items: (T | Iterable<T, any, any>)[]

        Items to add.

      Returns this

      This instance.

      -

    clear

    • clear(): this

    • Clears all items.

      +

    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 +

    clone

    • clone(opts?: { items?: CloneOps; options?: HashArrayOptions<T> }): 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

      • Optionalopts: {
            items?: CloneOps;
            options?: HashArrayOptions<T>;
        }

        Optional parameters.

        -
        • Optionalitems?: CloneOps

          Clone operation for items. By default, +

          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 +

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

    collides

    • collides(item: Partial<T>): 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.

      +

    entries

    entriesFlat

    filter

    • filter(key: Key, callbackOrIndex: Key | (item: T) => boolean): 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: T) => boolean)

        A Key to lookup for filter inclusion or a callback +

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

      +

    Returns HashArray<T>

    forEach

    • forEach(key: Key, callback: (item: T) => void): 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: 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 +

    • callback: (item: T) => void

      A callback invoked for each item.

      +

    Returns this

    This instance.

    +

    forEachDeep

    • forEachDeep(key: Key, index: Key, callback: (value: any, item: T) => void): 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: any, item: T) => void)

        A callback invoked for each item with value of index +

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

      +

    Returns this

    This instance.

    +

    get

    • get(key: string): T | T[]

    • Gets item(s) by the given key.

      Parameters

      • key: string

        The key for an item to retrieve.

        -

      Returns T | T[]

      All items stored by the given key.

      -

    getAll

    • getAll(keys): T[]

    • Gets all items stored by the given Key. You may pass * as a wildcard for all items.

      +

    Returns T | T[]

    All items stored by the given key.

    +

    getAll

    • getAll(keys: Key): T[]

    • Gets all items stored by the given Key. You may pass * as a wildcard for all items.

      Parameters

      • keys: Key

        The Key for item(s) to retrieve.

        -

      Returns T[]

      All item(s) for the given Key.

      -

    getAsArray

    • getAsArray(key): T[]

    • Gets item(s) by the given key always returning an array including an empty array when key is not in the HashArray.

      +

    Returns T[]

    All item(s) for the given Key.

    +

    getAsArray

    • getAsArray(key: string): T[]

    • Gets item(s) by the given key always returning an array including an empty array when key is not in the HashArray.

      Parameters

      • key: string

        The key for item(s) to retrieve.

        -

      Returns T[]

      All items for key or empty array.

      -

    getAt

    • getAt(index): T

    • Gets the item stored in the flat list of all items at the given index.

      +

    Returns T[]

    All items for key or empty array.

    +

    getAt

    • getAt(index: number): T

    • Gets the item stored in the flat list of all items at the given index.

      Parameters

      • index: number

        The index to retrieve.

        -

      Returns T

    has

    • has(key): boolean

    • Verifies if this HashArray has this key.

      +

    Returns T

    has

    • has(key: string): boolean

    • Verifies if this HashArray has this key.

      Parameters

      • key: string

        The key to check.

      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

      Returns HashArray<T>

      Returns a new HashArray that contains the intersection between this (A) and the HashArray +

    intersection

    • intersection(target: HashArray<T>, output?: HashArray<T>): HashArray<T>

    • Returns the intersection of this HashArray and a target HashArray.

      +

      Parameters

      Returns HashArray<T>

      Returns a new HashArray that contains the intersection between this (A) and the HashArray passed in (B). Returns A ^ B.

      -

    keys

    remove

    • remove(...items): this

    • Removes all item(s) given.

      -

      Parameters

      • Rest...items: T[]

        Items to remove.

        +

    keys

    remove

    • remove(...items: T[]): this

    • Removes all item(s) given.

      +

      Parameters

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

        +

    removeByKey

    • removeByKey(...keys: string[]): this

    • Remove item(s) associated with the given keys from the HashArray.

      +

      Parameters

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

      +

    removeFirst

    • removeFirst(): this

    • When treating HashArray as a cache removing the first item removes the oldest item.

      Returns this

      This instance.

      -

    removeLast

    • removeLast(): this

    • When treating HashArray as a cache removing the last item removes the newest item.

      +

    removeLast

    • removeLast(): this

    • When treating HashArray as a cache removing the last item removes the newest item.

      Returns this

      This instance.

      -

    values

    valuesFlat

    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 +

    values

    valuesFlat

    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 cf97d1f..704e537 100644 --- a/docs/classes/_runtime_data_struct_hash_array.HashArrayUtil.html +++ b/docs/classes/_runtime_data_struct_hash_array.HashArrayUtil.html @@ -1,5 +1,5 @@ -HashArrayUtil | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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.

    @@ -8,29 +8,29 @@ difference sample sum -

    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 +

    Constructors

    constructor

    Methods

    Staticaverage

    • average<T extends object>(
          source: HashArray<T>,
          key: Key,
          index: Key,
          weightKey?: Key,
      ): 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.

        +

        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.

        • OptionalweightKey: Key

          A specific Key in each item to provide a weighting value.

        Returns number

        The average value for the given iteration.

        -

    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 +

    Staticdifference

    • difference<T extends object>(
          source: HashArray<T>,
          target: HashArray<T>,
          output?: HashArray<T>,
      ): 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) +

    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.

    -

    Staticsample

    • sample<T>(source, count, key?): T[]

    • Type Parameters

      • T extends object

      Parameters

    Staticsample

    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

      Returns T[]

      Random subset of items.

      +

      See

      http://en.wikipedia.org/wiki/Image_(mathematics)

      +

    Staticsum

    • sum<T extends object>(
          source: HashArray<T>,
          key: Key,
          index: Key,
          weightKey?: Key,
      ): 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.

      • OptionalweightKey: Key

        A specific Key in each item to provide a weighting value.

      Returns number

      The sum for the given iteration.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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 0363e1e..6f93948 100644 --- a/docs/classes/_runtime_data_struct_search_trie.TrieSearch.html +++ b/docs/classes/_runtime_data_struct_search_trie.TrieSearch.html @@ -1,5 +1,5 @@ -TrieSearch | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 @@ -9,9 +9,9 @@ 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 -

    Accessors

    isDestroyed -keyFields +

    Type Parameters

    • T extends object

    Constructors

    constructor +

    Accessors

    isDestroyed +keyFields root size

    Methods

    add @@ -20,36 +20,36 @@ map search subscribe -

    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 +

    Constructors

    constructor

    • new TrieSearch<T extends object>(
          keyFields?: string | KeyFields,
          options?: TrieSearchOptions,
      ): 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.

      • 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

      • Rest...items: (T | Iterable<T, any, any>)[]

        Items to add.

        -

      Returns this

    clear

    • clear(): this

    • Clears all items.

      +

    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: (T | Iterable<T, any, any>)[]): this

    • Add items or list of items to the TrieSearch instance.

      +

      Parameters

      • ...items: (T | Iterable<T, any, any>)[]

        Items to add.

        +

      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 +

    destroy

    • destroy(): this

    • Destroys this TrieSearch instance. Removing all data and preventing new data from being added. Any subscribers are notified with an undefined argument in the callback signaling that the associated instance is destroyed.

      -

      Returns this

    map

    • map(key, value): this

    • Directly maps an item to the given key.

      +

      Returns this

    map

    • map(key: string, value: T): this

    • Directly maps an item to the given key.

      Parameters

      • key: string

        The key to store the item.

        -
      • value: T

        The item to store.

        -

      Returns this

    search

    • search(phrases, options?): T[]

    • Performs a search of the trie data structure with the given phrases. By default, each phrase is split by -TrieSearchOptions.splitOnGetRegEx and matches found for each word resulting in a OR lookup. You may +

    • value: T

      The item to store.

      +

    Returns this

    search

    • search(
          phrases: string | Iterable<string, any, any>,
          options?: { limit?: number; list?: T[]; reducer?: TrieSearchReducer<T> },
      ): T[]

    • Performs a search of the trie data structure with the given phrases. By default, each phrase is split by +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, any, any>

        The phrases to parse and search in the trie data structure.

        -
      • Optionaloptions: {
            limit?: number;
            list?: T[];
            reducer?: TrieSearchReducer<T>;
        }

        Search Options.

        -
        • Optionallimit?: number

          The limit for search results returned.

          -
        • Optionallist?: T[]

          An external array to use for storing search results.

          -
        • Optionalreducer?: TrieSearchReducer<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.

      +

      Parameters

      • phrases: string | Iterable<string, any, any>

        The phrases to parse and search in the trie data structure.

        +
      • Optionaloptions: { limit?: number; list?: T[]; reducer?: TrieSearchReducer<T> }

        Search Options.

        +
        • Optionallimit?: number

          The limit for search results returned.

          +
        • Optionallist?: T[]

          An external array to use for storing search results.

          +
        • Optionalreducer?: TrieSearchReducer<T>

          A trie reducer instance to apply to this search.

          +

      Returns T[]

      Found matches.

      +

    subscribe

    • subscribe(handler: TrieSearchSubscribeHandler<T>): () => 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 instance is sent as the only argument. When it is undefined this signals that the TrieSearch instance has been destroyed.

      -

      Parameters

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns () => void

    Unsubscribe function.

    +

    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 cdc0366..eaad6ca 100644 --- a/docs/classes/_runtime_data_struct_search_trie.UnionReducer.html +++ b/docs/classes/_runtime_data_struct_search_trie.UnionReducer.html @@ -1,7 +1,7 @@ -UnionReducer | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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
    +

    Type Parameters

    • T extends object
    @@ -9,17 +9,17 @@
    -
    +

    Constructors

    constructor -

    Accessors

    keyFields +

    Accessors

    keyFields matches

    Methods

    reduce reset -

    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

    reset

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    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

    reset

    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 296abde..31effa9 100644 --- a/docs/classes/_runtime_data_struct_search_trie_query.TrieSearchQuery.html +++ b/docs/classes/_runtime_data_struct_search_trie_query.TrieSearchQuery.html @@ -1,7 +1,7 @@ -TrieSearchQuery | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    Class TrieSearchQuery<T>

    Provides a reactive query interface to TrieSearch in addition to dynamic filtering / sorting of search results.

    -

    Type Parameters

    • T extends object
    +

    Type Parameters

    • T extends object
    @@ -9,7 +9,7 @@
    Hierarchy
    -
    +

    Constructors

    constructor

    Accessors

    data @@ -17,54 +17,54 @@
    destroyed filters index -isDestroyed +isDestroyed length limit query reversed sort -trieReducer -trieSearch -

    Methods

    [iterator] +trieReducer +trieSearch +

    Methods

    [iterator] destroy initialize -setData +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.

      -

      Returns T[]

      The internal data.

      -

    derived

    destroyed

    • get destroyed(): boolean

    • Returns boolean

      Returns whether this instance is destroyed.

      -

    filters

    index

    isDestroyed

    • get isDestroyed(): boolean

    • Returns boolean

      The current destroyed state of this query instance.

      -

    length

    • get length(): number

    • Gets the main data / items length.

      +

      Returns T[]

      The internal data.

      +

    derived

    destroyed

    • get destroyed(): boolean

    • Returns boolean

      Returns whether this instance is destroyed.

      +

    filters

    index

    isDestroyed

    • get isDestroyed(): boolean

    • Returns boolean

      The current destroyed state of this query instance.

      +

    length

    • get length(): number

    • Gets the main data / items length.

      Returns number

      Main data / items length.

      -

    limit

    • get limit(): Writable<number>

    • Returns Writable<number>

      The writable store controlling the search results limit.

      -

    query

    • get query(): Writable<string | Iterable<string, any, any>>

    • Returns Writable<string | Iterable<string, any, any>>

      The writable store controlling the search query.

      -

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      +

    limit

    • get limit(): Writable<number>

    • Returns Writable<number>

      The writable store controlling the search results limit.

      +

    query

    • get query(): Writable<string | Iterable<string, any, any>>

    • Returns Writable<string | Iterable<string, any, any>>

      The writable store controlling the search query.

      +

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      Returns boolean

      Reversed state.

      -
    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      +
    • set reversed(reversed: boolean): void

    • Sets reversed state and notifies subscribers.

      Parameters

      • reversed: boolean

        New reversed state.

        -

      Returns void

    sort

    trieReducer

    trieSearch

    Methods

    [iterator]

    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 +

    Returns void

    sort

    trieReducer

    trieSearch

    Methods

    [iterator]

    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 +

      Returns void

    setData

    • setData(data: Iterable<T, any, any> | T[], replace?: boolean): 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, any, any> | T[]

        New data to set to internal data.

        +

        Parameters

        • data: Iterable<T, any, any> | T[]

          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: DynArrayReducer<T>) => void)

        Callback function that is invoked on update / changes. +

      Returns void

    subscribe

    • subscribe(handler: (value: DynArrayReducer<T>) => void): () => void

    • Add a subscriber to this DynArrayReducer instance.

      +

      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

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns () => void

    Unsubscribe function.

    +

    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 deleted file mode 100644 index 4718268..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Mat2.html +++ /dev/null @@ -1,362 +0,0 @@ -Mat2 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Mat2

    A 2x2 Matrix

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    str -

    Constructor

    constructor -

    Methods

    copy -identity -invert -mul -multiply -rotate -scale -transpose -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -add -adjoint -clone -copy -create -determinant -equals -exactEquals -frob -fromRotation -fromScaling -fromValues -identity -invert -LDU -mul -multiply -multiplyScalar -multiplyScalarAndAdd -rotate -scale -set -str -sub -subtract -transpose -

    Accessors

    str

    • get str(): string

    • A string representation of this -Equivalent to Mat2.str(this);

      -

      Returns string

    Constructor

    constructor

    Methods

    copy

    • copy(a): this

    • Copy the values from another Mat2 into this.

      -

      Parameters

      Returns this

      this

      -

    identity

    • identity(): this

    • Set this to the identity matrix -Equivalent to Mat2.identity(this)

      -

      Returns this

      this

      -

    invert

    • invert(): this

    • Inverts this Mat2 -Equivalent to Mat4.invert(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this Mat2 against another one -Equivalent to Mat2.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    rotate

    • rotate(rad): this

    • Rotates this Mat2 by the given angle around the given axis -Equivalent to Mat2.rotate(this, this, rad);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -

      Returns this

      this

      -

    scale

    • scale(v): this

    • Scales this Mat2 by the dimensions in the given vec3 not using vectorization -Equivalent to Mat2.scale(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    transpose

    • transpose(): this

    • Transpose this Mat2 -Equivalent to Mat2.transpose(this, this);

      -

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat2.

      -

    Staticadd

    Staticadjoint

    Staticclone

    Staticcopy

    Staticcreate

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat2

      -

      Parameters

      Returns number

      determinant of a

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether two Mat2s have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat2

      -

      Parameters

      Returns number

      Frobenius norm

      -

    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);
-
      - -

      Parameters

      • out: Mat2Like

        Mat2 receiving operation result

        -
      • rad: number

        the angle to rotate the matrix by

        -

      Returns Mat2Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat2Like

      out

      -

    StaticfromValues

    • fromValues(...values): Mat2

    • Create a new Mat2 with the given values

      -

      Parameters

      • Rest...values: number[]

        Matrix components

        -

      Returns Mat2

      A new Mat2

      -

    Staticidentity

    Staticinvert

    StaticLDU

    Staticmul

    Staticmultiply

    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

      -

    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

      -

    Staticrotate

    Staticscale

    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

        -

      Returns Mat2Like

      out

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat2

      -

      Parameters

      Returns string

      string representation of the matrix

      -

    Staticsub

    Staticsubtract

    Statictranspose

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructor
    Methods
    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 deleted file mode 100644 index 2e5ad80..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Mat2d.html +++ /dev/null @@ -1,358 +0,0 @@ -Mat2d | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Mat2d

    A 2x3 Matrix

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    str -

    Constructor

    constructor -

    Methods

    copy -identity -mul -multiply -rotate -scale -translate -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -add -clone -copy -create -determinant -equals -exactEquals -frob -fromRotation -fromScaling -fromTranslation -fromValues -identity -invert -mul -multiply -multiplyScalar -multiplyScalarAndAdd -rotate -scale -set -str -sub -subtract -translate -

    Accessors

    str

    • get str(): string

    • A string representation of this -Equivalent to Mat2d.str(this);

      -

      Returns string

    Constructor

    constructor

    Methods

    copy

    • copy(a): this

    • Copy the values from another Mat2d into this.

      -

      Parameters

      Returns this

      this

      -

    identity

    • identity(): this

    • Set this to the identity matrix -Equivalent to Mat2d.identity(this)

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this Mat2d against another one -Equivalent to Mat2d.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    rotate

    • rotate(rad): this

    • Rotates this Mat2d by the given angle around the given axis -Equivalent to Mat2d.rotate(this, this, rad);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -

      Returns this

      this

      -

    scale

    • scale(v): this

    • Scales this Mat2d by the dimensions in the given vec3 not using vectorization -Equivalent to Mat2d.scale(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    translate

    • translate(v): this

    • Translate this Mat2d by the given vector -Equivalent to Mat2d.translate(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat2d.

      -

    Staticadd

    Staticclone

    Staticcopy

    Staticcreate

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat2d

      -

      Parameters

      Returns number

      determinant of a

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether two Mat2ds have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat2d

      -

      Parameters

      Returns number

      Frobenius norm

      -

    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);
-
      - -

      Parameters

      • out: Mat2dLike

        Mat2d receiving operation result

        -
      • rad: number

        the angle to rotate the matrix by

        -

      Returns Mat2dLike

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat2dLike

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat2dLike

      out

      -

    StaticfromValues

    • fromValues(...values): Mat2d

    • Create a new Mat2d with the given values

      -

      Parameters

      • Rest...values: number[]

        Matrix components

        -

      Returns Mat2d

      A new Mat2d

      -

    Staticidentity

    Staticinvert

    Staticmul

    Staticmultiply

    StaticmultiplyScalar

    • multiplyScalar(out, a, b): Mat2dLike

    • Multiply each element of a Mat2d by a scalar.

      -

      Parameters

      • out: Mat2dLike

        the receiving matrix

        -
      • a: Readonly<Mat2dLike>

        the matrix to scale

        -
      • b: number

        amount to scale the matrix's elements by

        -

      Returns Mat2dLike

      out

      -

    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

      -

    Staticrotate

    Staticscale

    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

        -

      Returns Mat2dLike

      out

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat2d

      -

      Parameters

      Returns string

      string representation of the matrix

      -

    Staticsub

    Staticsubtract

    Statictranslate

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructor
    Methods
    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 deleted file mode 100644 index d83fb6a..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Mat3.html +++ /dev/null @@ -1,412 +0,0 @@ -Mat3 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Mat3

    A 3x3 Matrix

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    str -

    Constructor

    constructor -

    Methods

    copy -identity -invert -mul -multiply -rotate -scale -translate -transpose -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -add -adjoint -clone -copy -create -determinant -equals -exactEquals -frob -fromMat2d -fromMat4 -fromQuat -fromRotation -fromScaling -fromTranslation -fromValues -identity -invert -mul -multiply -multiplyScalar -multiplyScalarAndAdd -normalFromMat4 -normalFromMat4Fast -projection -rotate -scale -set -str -sub -subtract -translate -transpose -

    Accessors

    str

    • get str(): string

    • A string representation of this -Equivalent to Mat3.str(this);

      -

      Returns string

    Constructor

    constructor

    Methods

    copy

    • copy(a): this

    • Copy the values from another Mat3 into this.

      -

      Parameters

      Returns this

      this

      -

    identity

    • identity(): this

    • Set this to the identity matrix -Equivalent to Mat3.identity(this)

      -

      Returns this

      this

      -

    invert

    • invert(): this

    • Inverts this Mat3 -Equivalent to Mat4.invert(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this Mat3 against another one -Equivalent to Mat3.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    rotate

    • rotate(rad): this

    • Rotates this Mat3 by the given angle around the given axis -Equivalent to Mat3.rotate(this, this, rad);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -

      Returns this

      this

      -

    scale

    • scale(v): this

    • Scales this Mat3 by the dimensions in the given vec3 not using vectorization -Equivalent to Mat3.scale(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    translate

    • translate(v): this

    • Translate this Mat3 by the given vector -Equivalent to Mat3.translate(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    transpose

    • transpose(): this

    • Transpose this Mat3 -Equivalent to Mat3.transpose(this, this);

      -

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat3.

      -

    Staticadd

    Staticadjoint

    Staticclone

    Staticcopy

    Staticcreate

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat3

      -

      Parameters

      Returns number

      determinant of a

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether two Mat3s have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat3

      -

      Parameters

      Returns number

      Frobenius norm

      -

    StaticfromMat2d

    StaticfromMat4

    StaticfromQuat

    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);
-
      -

      Parameters

      • out: Mat3Like

        Mat3 receiving operation result

        -
      • rad: number

        the angle to rotate the matrix by

        -

      Returns Mat3Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat3Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat3Like

      out

      -

    StaticfromValues

    • fromValues(...values): Mat3

    • Create a new Mat3 with the given values

      -

      Parameters

      • Rest...values: number[]

        Matrix components

        -

      Returns Mat3

      A new Mat3

      -

    Staticidentity

    Staticinvert

    Staticmul

    Staticmultiply

    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

      -

    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

      -

    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 invertible

      -

    StaticnormalFromMat4Fast

    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

      -

    Staticrotate

    Staticscale

    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

        -

      Returns Mat3Like

      out

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat3

      -

      Parameters

      Returns string

      string representation of the matrix

      -

    Staticsub

    Staticsubtract

    Statictranslate

    Statictranspose

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructor
    Methods
    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 deleted file mode 100644 index 16b27b2..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Mat4.html +++ /dev/null @@ -1,676 +0,0 @@ -Mat4 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Mat4

    A 4x4 Matrix

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    str -

    Constructor

    constructor -

    Methods

    copy -identity -invert -mul -multiply -orthoNO -orthoZO -perspectiveNO -perspectiveZO -rotate -rotateX -rotateY -rotateZ -scale -translate -transpose -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -add -adjoint -clone -copy -create -decompose -determinant -equals -exactEquals -frob -fromQuat -fromQuat2 -fromRotation -fromRotationTranslation -fromRotationTranslationScale -fromRotationTranslationScaleOrigin -fromScaling -fromTranslation -fromValues -fromXRotation -fromYRotation -fromZRotation -frustum -frustumNO -frustumZO -getRotation -getScaling -getTranslation -identity -invert -lookAt -mul -multiply -multiplyScalar -multiplyScalarAndAdd -normalFromMat4 -normalFromMat4Fast -ortho -orthoNO -orthoZO -perspective -perspectiveFromFieldOfView -perspectiveNO -perspectiveZO -rotate -rotateX -rotateY -rotateZ -scale -set -str -sub -subtract -targetTo -translate -transpose -

    Accessors

    str

    • get str(): string

    • A string representation of this -Equivalent to Mat4.str(this);

      -

      Returns string

    Constructor

    constructor

    Methods

    copy

    • copy(a): this

    • Copy the values from another Mat4 into this.

      -

      Parameters

      Returns this

      this

      -

    identity

    • identity(): this

    • Set this to the identity matrix -Equivalent to Mat4.identity(this)

      -

      Returns this

      this

      -

    invert

    • invert(): this

    • Inverts this Mat4 -Equivalent to Mat4.invert(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this Mat4 against another one -Equivalent to Mat4.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    orthoNO

    • orthoNO(left, right, bottom, top, near, far): this

    • 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. -Equivalent to Mat4.orthoNO(this, left, right, bottom, top, near, far);

      -

      Parameters

      • 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

        -

      Returns this

      this

      -

    orthoZO

    • orthoZO(left, right, bottom, top, near, far): this

    • 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. -Equivalent to Mat4.orthoZO(this, left, right, bottom, top, near, far);

      -

      Parameters

      • 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

        -

      Returns this

      this

      -

    perspectiveNO

    • perspectiveNO(fovy, aspect, near, far): this

    • 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. -Equivalent to Mat4.perspectiveNO(this, fovy, aspect, near, far);

      -

      Parameters

      • 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

        -

      Returns this

      this

      -

    perspectiveZO

    • perspectiveZO(fovy, aspect, near, far): this

    • 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. -Equivalent to Mat4.perspectiveZO(this, fovy, aspect, near, far);

      -

      Parameters

      • 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

        -

      Returns this

      this

      -

    rotate

    • rotate(rad, axis): this

    • Rotates this Mat4 by the given angle around the given axis -Equivalent to Mat4.rotate(this, this, rad, axis);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -
      • axis: Readonly<Vec3Like>

        the axis to rotate around

        -

      Returns this

      this

      -

    rotateX

    • rotateX(rad): this

    • Rotates this Mat4 by the given angle around the X axis -Equivalent to Mat4.rotateX(this, this, rad);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -

      Returns this

      this

      -

    rotateY

    • rotateY(rad): this

    • Rotates this Mat4 by the given angle around the Y axis -Equivalent to Mat4.rotateY(this, this, rad);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -

      Returns this

      this

      -

    rotateZ

    • rotateZ(rad): this

    • Rotates this Mat4 by the given angle around the Z axis -Equivalent to Mat4.rotateZ(this, this, rad);

      -

      Parameters

      • rad: number

        the angle to rotate the matrix by

        -

      Returns this

      this

      -

    scale

    • scale(v): this

    • Scales this Mat4 by the dimensions in the given vec3 not using vectorization -Equivalent to Mat4.scale(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    translate

    • translate(v): this

    • Translate this Mat4 by the given vector -Equivalent to Mat4.translate(this, this, v);

      -

      Parameters

      Returns this

      this

      -

    transpose

    • transpose(): this

    • Transpose this Mat4 -Equivalent to Mat4.transpose(this, this);

      -

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Mat4.

      -

    Staticadd

    Staticadjoint

    Staticclone

    Staticcopy

    Staticcreate

    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

      -

    Staticdeterminant

    • determinant(a): number

    • Calculates the determinant of a Mat4

      -

      Parameters

      Returns number

      determinant of a

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether two Mat4s have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the matrices are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfrob

    • frob(a): number

    • Returns Frobenius norm of a Mat4

      -

      Parameters

      Returns number

      Frobenius norm

      -

    StaticfromQuat

    • fromQuat(out, q): Mat4Like

    • Calculates a 4x4 matrix from the given quaternion

      -

      Parameters

      Returns Mat4Like

      out

      -

    StaticfromQuat2

    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);
-
      - -

      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 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);
-
      - -

      Parameters

      Returns Mat4Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat4Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat4Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat4Like

      out

      -

    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);
-
      - -

      Parameters

      Returns Mat4Like

      out

      -

    StaticfromValues

    • fromValues(...values): Mat4

    • Create a new mat4 with the given values

      -

      Parameters

      • Rest...values: number[]

        Matrix components

        -

      Returns Mat4

      A new Mat4

      -

    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);
-
      - -

      Parameters

      • out: Mat4Like

        mat4 receiving operation result

        -
      • rad: number

        the angle to rotate the matrix by

        -

      Returns Mat4Like

      out

      -

    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);
-
      - -

      Parameters

      • out: Mat4Like

        mat4 receiving operation result

        -
      • rad: number

        the angle to rotate the matrix by

        -

      Returns Mat4Like

      out

      -

    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);
-
      - -

      Parameters

      • out: Mat4Like

        mat4 receiving operation result

        -
      • rad: number

        the angle to rotate the matrix by

        -

      Returns Mat4Like

      out

      -

    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

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

      -

    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

      -

    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 parameter, the returned vector will be -the same as the scaling vector -originally supplied.

      -

      Parameters

      Returns Vec3Like

      out

      -

    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

      -

    Staticidentity

    Staticinvert

    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

      -

    Staticmul

    Staticmultiply

    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

      -

    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

      -

    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 invertible

      -

    StaticnormalFromMat4Fast

    Staticortho

    StaticorthoNO

    • orthoNO(out, left, right, bottom, top, near, far): Mat4Like

    • Generates an 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 / OpenGLs clip volume.

      -

      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

        -

      Returns Mat4Like

      out

      -

    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

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

        -

      Returns Mat4Like

      out

      -

    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 experimental WebVR API.

      -

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        -
      • fov: {
            downDegrees: number;
            leftDegrees: number;
            rightDegrees: number;
            upDegrees: number;
        }

        Object containing the following values: upDegrees, downDegrees, leftDegrees, rightDegrees

        -
        • downDegrees: number
        • leftDegrees: number
        • rightDegrees: number
        • upDegrees: number
      • near: number

        Near bound of the frustum

        -
      • far: number

        Far bound of the frustum

        -

      Returns Mat4Like

      out

      -

      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.

      -

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        -
      • fovy: number

        Vertical field of view in radians

        -
      • aspect: number

        Aspect ratio. typically viewport width/height

        -
      • near: number

        Near bound of the frustum

        -
      • Optionalfar: number

        Far bound of the frustum, can be null or Infinity

        -

      Returns Mat4Like

      out

      -

    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.

      -

      Parameters

      • out: Mat4Like

        mat4 frustum matrix will be written into

        -
      • fovy: number

        Vertical field of view in radians

        -
      • aspect: number

        Aspect ratio. typically viewport width/height

        -
      • near: number

        Near bound of the frustum

        -
      • Optionalfar: number

        Far bound of the frustum, can be null or Infinity

        -

      Returns Mat4Like

      out

      -

    Staticrotate

    • rotate(out, a, rad, axis): Mat4Like

    • Rotates a Mat4 by the given angle around the given axis

      -

      Parameters

      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

      -

    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

      -

    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

      -

    Staticscale

    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

        -

      Returns Mat4Like

      out

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a Mat4

      -

      Parameters

      Returns string

      string representation of the matrix

      -

    Staticsub

    Staticsubtract

    StatictargetTo

    Statictranslate

    Statictranspose

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructor
    Methods
    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 deleted file mode 100644 index d9b7f28..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Quat.html +++ /dev/null @@ -1,478 +0,0 @@ -Quat | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Quat

    Quaternion

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    mag -magnitude -str -

    Constructor

    constructor -

    Methods

    copy -dot -identity -invert -mul -multiply -rotateX -rotateY -rotateZ -scale -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Quaternion Components

    w -x -y -z -

    Static

    BYTE_LENGTH -add -calculateW -clone -conjugate -copy -create -dot -equals -exactEquals -exp -fromEuler -fromMat3 -fromValues -getAngle -getAxisAngle -identity -invert -len -length -lerp -ln -mag -magnitude -mul -multiply -normalize -pow -rotateX -rotateY -rotateZ -rotationTo -scale -set -setAxes -setAxisAngle -slerp -sqlerp -sqrLen -squaredLength -str -

    Accessors

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

    Constructor

    constructor

    Methods

    copy

    • copy(a): this

    • Copy the values from another Quat into this.

      -

      Parameters

      Returns this

      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

      -

    identity

    • identity(): this

    • Set this to the identity quaternion -Equivalent to Quat.identity(this)

      -

      Returns this

      this

      -

    invert

    • invert(): this

    • Inverts this -Equivalent to Quat.invert(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this by a Quat. -Equivalent to Quat.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    rotateX

    • rotateX(rad): this

    • Rotates this by the given angle about the X axis -Equivalent to Quat.rotateX(this, this, rad);

      -

      Parameters

      • rad: number

        angle (in radians) to rotate

        -

      Returns this

      this

      -

    rotateY

    • rotateY(rad): this

    • Rotates this by the given angle about the Y axis -Equivalent to Quat.rotateY(this, this, rad);

      -

      Parameters

      • rad: number

        angle (in radians) to rotate

        -

      Returns this

      this

      -

    rotateZ

    • rotateZ(rad): this

    • Rotates this by the given angle about the Z axis -Equivalent to Quat.rotateZ(this, this, rad);

      -

      Parameters

      • rad: number

        angle (in radians) to rotate

        -

      Returns this

      this

      -

    scale

    • scale(scale): Vec4Like

    • Scales this by a scalar number -Equivalent to Quat.scale(this, this, scale);

      -

      Parameters

      • scale: number

        amount to scale the vector by

        -

      Returns Vec4Like

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Quat.

      -

    Staticadd

    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

      -

    Staticclone

    • clone(a): Quat

    • Creates a new quat initialized with values from an existing quaternion

      -

      Parameters

      Returns Quat

      a new quaternion

      -

    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

      -

    Staticcopy

    Staticcreate

    • create(): Quat

    • Creates a new identity quat

      -

      Returns Quat

      a new quaternion

      -

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two quat's

      -

      Parameters

      Returns number

      dot product of a and b

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether the quaternions have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticexp

    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

      -

    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 re-normalize the quaternion yourself where necessary.

      -

      Parameters

      Returns Vec4Like

      out

      -

    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

      -

    StaticgetAngle

    • getAngle(a, b): number

    • Gets the angular distance between two unit quaternions

      -

      Parameters

      Returns number

      Angle, in radians, between the two quaternions

      -

    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 provided 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.

      -

      Parameters

      Returns number

      Angle, in radians, of the rotation

      -

    Staticidentity

    • identity(out): Vec4Like

    • Set a quat to the identity quaternion

      -

      Parameters

      Returns Vec4Like

      out

      -

    Staticinvert

    Staticlen

    Staticlength

    Staticlerp

    • lerp(out, a, b, t): Vec4Like

    • Performs a linear interpolation between two quat's

      -

      Parameters

      Returns Vec4Like

      out

      -

    Staticln

    • ln(out, a): Vec4Like

    • Calculate the natural logarithm of a unit quaternion.

      -

      Parameters

      Returns Vec4Like

      out

      -

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Quat

      -

      Parameters

      Returns number

      length of a

      -

    Staticmul

    Staticmultiply

    Staticnormalize

    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

      -

    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

      -

    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

      -

    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

      -

    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

      -

    Staticscale

    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

      -

    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

      -

    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

      -

    Staticslerp

    • slerp(out, a, b, t): Vec4Like

    • Performs a spherical linear interpolation between two quat

      -

      Parameters

      Returns Vec4Like

      out

      -

    Staticsqlerp

    StaticsqrLen

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Quat

      -

      Parameters

      Returns number

      squared length of a

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a quatenion

      -

      Parameters

      Returns string

      string representation of the vector

      -

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructor
    Methods
    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 deleted file mode 100644 index 72a0f30..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Quat2.html +++ /dev/null @@ -1,419 +0,0 @@ -Quat2 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Quat2

    Dual Quaternion

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    str -

    Constructor

    constructor -

    Methods

    copy -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -add -clone -conjugate -copy -create -dot -equals -exactEquals -fromMat4 -fromRotation -fromRotationTranslation -fromRotationTranslationValues -fromTranslation -fromValues -getDual -getReal -getTranslation -identity -invert -len -length -lerp -mag -magnitude -mul -multiply -normalize -rotateAroundAxis -rotateByQuatAppend -rotateByQuatPrepend -rotateX -rotateY -rotateZ -scale -set -setDual -setReal -sqrLen -squaredLength -str -translate -

    Accessors

    str

    • get str(): string

    • A string representation of this -Equivalent to Quat2.str(this);

      -

      Returns string

    Constructor

    constructor

    Methods

    copy

    • copy(a): this

    • Copy the values from another Quat2 into this.

      -

      Parameters

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Quat2.

      -

    Staticadd

    Staticclone

    • clone(a): Quat2

    • Creates a Quat2 quat initialized with values from an existing quaternion

      -

      Parameters

      Returns Quat2

      a new dual quaternion

      -

    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

      -

    Staticcopy

    Staticcreate

    • create(): Quat2

    • Creates a new identity Quat2

      -

      Returns Quat2

      a new dual quaternion [real -> rotation, dual -> translation]

      -

    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

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether the Quat2s have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the dual quaternions are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    StaticfromMat4

    StaticfromRotation

    StaticfromRotationTranslation

    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)

        -
      • w1: number

        W component (rotation)

        -
      • x2: number

        X component (translation)

        -
      • y2: number

        Y component (translation)

        -
      • z2: number

        Z component (translation)

        -

      Returns Quat2

      a new dual quaternion

      -

    StaticfromTranslation

    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

        -
      • w1: number

        1st W component

        -
      • x2: number

        2nd X component

        -
      • y2: number

        2nd Y component

        -
      • z2: number

        2nd Z component

        -
      • w2: number

        2nd W component

        -

      Returns Quat2

      a new dual quaternion

      -

    StaticgetDual

    StaticgetReal

    StaticgetTranslation

    Staticidentity

    Staticinvert

    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

      -

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Quat2

      -

      Parameters

      Returns number

      length of a

      -

    Staticmul

    Staticmultiply

    Staticnormalize

    StaticrotateAroundAxis

    • rotateAroundAxis(out, a, axis, rad): Quat2Like

    • Rotates a Quat2 around a given axis. Does the normalization automatically

      -

      Parameters

      Returns Quat2Like

      out

      -

    StaticrotateByQuatAppend

    StaticrotateByQuatPrepend

    StaticrotateX

    StaticrotateY

    StaticrotateZ

    Staticscale

    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

        -
      • z1: number

        1st Z component

        -
      • w1: number

        1st W component

        -
      • x2: number

        2nd X component

        -
      • y2: number

        2nd Y component

        -
      • z2: number

        2nd Z component

        -
      • w2: number

        2nd W component

        -

      Returns Quat2Like

      out

      -

    StaticsetDual

    StaticsetReal

    StaticsqrLen

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Quat2

      -

      Parameters

      Returns number

      squared length of a

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a Quat2

      -

      Parameters

      Returns string

      string representation of the vector

      -

    Statictranslate

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructor
    Methods
    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 deleted file mode 100644 index 3407216..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Vec2.html +++ /dev/null @@ -1,516 +0,0 @@ -Vec2 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Vec2

    2 Dimensional Vector

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    mag -magnitude -sqrMag -squaredMagnitude -str -

    Color Components

    g -r -

    Constructor

    constructor -

    Methods

    abs -add -copy -dist -distance -div -divide -dot -invert -mul -multiply -negate -normalize -scale -scaleAndAdd -sqrDist -squaredDistance -sub -subtract -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -abs -add -angle -ceil -clone -copy -create -cross -dist -distance -div -divide -dot -equals -exactEquals -floor -fromValues -inverse -len -length -lerp -mag -magnitude -max -min -mul -multiply -negate -normalize -rotate -round -scale -scaleAndAdd -set -sqrDist -sqrLen -squaredDistance -squaredLength -str -sub -subtract -transformMat2 -transformMat2d -transformMat3 -transformMat4 -zero -

    Vector Components

    x -y -

    Accessors

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

    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

    Constructor

    constructor

    Methods

    abs

    • abs(): this

    • Sets each component of this to it's absolute value. -Equivalent to Vec2.abs(this, this);

      -

      Returns this

      this

      -

    add

    • add(b): this

    • Adds a Vec2 to this. -Equivalent to Vec2.add(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    copy

    • copy(a): this

    • Copy the values from another Vec2 into this.

      -

      Parameters

      Returns this

      this

      -

    dist

    distance

    • distance(b): number

    • Calculates the Euclidean distance between another Vec2 and this. -Equivalent to Vec2.distance(this, b);

      -

      Parameters

      Returns number

      Distance between this and b

      -

    div

    divide

    • divide(b): this

    • Divides this by a Vec2. -Equivalent to Vec2.divide(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    dot

    • dot(b): number

    • Calculates the dot product of this and another Vec2. -Equivalent to Vec2.dot(this, b);

      -

      Parameters

      Returns number

      Dot product of this and b

      -

    invert

    • invert(): this

    • Inverts the components of this. -Equivalent to Vec2.inverse(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this by a Vec2. -Equivalent to Vec2.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    negate

    • negate(): this

    • Negates the components of this. -Equivalent to Vec2.negate(this, this);

      -

      Returns this

      this

      -

    normalize

    • normalize(): this

    • Normalize this. -Equivalent to Vec2.normalize(this, this);

      -

      Returns this

      this

      -

    scale

    • scale(b): this

    • Scales this by a scalar number. -Equivalent to Vec2.scale(this, this, b);

      -

      Parameters

      • b: number

        Amount to scale this by

        -

      Returns this

      this

      -

    scaleAndAdd

    • scaleAndAdd(b, scale): this

    • Calculates this scaled by a scalar value then adds the result to this. -Equivalent to Vec2.scaleAndAdd(this, this, b, scale);

      -

      Parameters

      • b: Readonly<Vec2Like>

        The vector to add to this

        -
      • scale: number

        The amount to scale b by before adding

        -

      Returns this

      this

      -

    sqrDist

    squaredDistance

    • squaredDistance(b): number

    • Calculates the squared Euclidean distance between another Vec2 and this. -Equivalent to Vec2.squaredDistance(this, b);

      -

      Parameters

      Returns number

      Squared distance between this and b

      -

    sub

    subtract

    • subtract(b): this

    • Subtracts a Vec2 from this. -Equivalent to Vec2.subtract(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Vec2.

      -

    Staticabs

    Staticadd

    Staticangle

    • angle(a, b): number

    • Get the angle between two 2D vectors

      -

      Parameters

      Returns number

      The angle in radians

      -

    Staticceil

    Staticclone

    • clone(a): Vec2

    • Creates a new Vec2 initialized with values from an existing vector

      -

      Parameters

      Returns Vec2

      A new 2D vector

      -

    Staticcopy

    Staticcreate

    • create(): Vec2

    • Creates a new, empty Vec2

      -

      Returns Vec2

      A new 2D vector

      -

    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

      -

    Staticdist

    Staticdistance

    • distance(a, b): number

    • Calculates the Euclidean distance between two Vec2s

      -

      Parameters

      Returns number

      distance between a and b

      -

    Staticdiv

    Staticdivide

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two Vec2s

      -

      Parameters

      Returns number

      Dot product of a and b

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether the vectors have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      true if the vectors are approximately equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfloor

    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

      -

    Staticinverse

    Staticlen

    Staticlength

    Staticlerp

    • lerp(out, a, b, t): Vec2Like

    • Performs a linear interpolation between two Vec2s

      -

      Parameters

      Returns Vec2Like

      out

      -

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec2

      -

      Parameters

      Returns number

      Magnitude of a

      -

    Staticmax

    Staticmin

    Staticmul

    Staticmultiply

    Staticnegate

    Staticnormalize

    Staticrotate

    Staticround

    Staticscale

    StaticscaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec2Like

    • Adds two Vec2's after scaling the second operand by a scalar value

      -

      Parameters

      Returns Vec2Like

      out

      -

    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

      -

    StaticsqrDist

    StaticsqrLen

    StaticsquaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared Euclidean distance between two Vec2s

      -

      Parameters

      Returns number

      Squared distance between a and b

      -

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Vec2

      -

      Parameters

      Returns number

      Squared length of a

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a vector

      -

      Parameters

      Returns string

      String representation of the vector

      -

    Staticsub

    Staticsubtract

    StatictransformMat2

    StatictransformMat2d

    StatictransformMat3

    StatictransformMat4

    Staticzero

    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

    On This Page

    Accessors
    Color Components
    Constructor
    Methods
    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 deleted file mode 100644 index 1fd7aa6..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Vec3.html +++ /dev/null @@ -1,547 +0,0 @@ -Vec3 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Vec3

    3 Dimensional Vector

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    mag -magnitude -sqrMag -squaredMagnitude -str -

    Color Components

    b -g -r -

    Constructor

    constructor -

    Methods

    abs -add -copy -dist -distance -div -divide -dot -invert -mul -multiply -negate -normalize -scale -scaleAndAdd -sqrDist -squaredDistance -sub -subtract -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -abs -add -angle -bezier -ceil -clone -copy -create -cross -dist -distance -div -divide -dot -equals -exactEquals -floor -fromValues -hermite -inverse -len -length -lerp -mag -magnitude -max -min -mul -multiply -negate -normalize -rotateX -rotateY -rotateZ -scale -scaleAndAdd -set -slerp -sqrDist -sqrLen -squaredDistance -squaredLength -str -sub -subtract -transformMat3 -transformMat4 -transformQuat -zero -

    Vector Components

    x -y -z -

    Accessors

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

    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

    Constructor

    constructor

    Methods

    abs

    • abs(): this

    • Sets each component of this to its absolute value. -Equivalent to Vec3.abs(this, this);

      -

      Returns this

      this

      -

    add

    • add(b): this

    • Adds a Vec3 to this. -Equivalent to Vec3.add(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    copy

    • copy(a): this

    • Copy the values from another Vec3 into this.

      -

      Parameters

      Returns this

      this

      -

    dist

    distance

    • distance(b): number

    • Calculates the Euclidean distance between another Vec3 and this. -Equivalent to Vec3.distance(this, b);

      -

      Parameters

      Returns number

      Distance between this and b

      -

    div

    divide

    • divide(b): this

    • Divides this by a Vec3. -Equivalent to Vec3.divide(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    dot

    • dot(b): number

    • Calculates the dot product of this and another Vec3. -Equivalent to Vec3.dot(this, b);

      -

      Parameters

      Returns number

      Dot product of this and b

      -

    invert

    • invert(): this

    • Inverts the components of this. -Equivalent to Vec3.inverse(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this by a Vec3. -Equivalent to Vec3.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    negate

    • negate(): this

    • Negates the components of this. -Equivalent to Vec3.negate(this, this);

      -

      Returns this

      this

      -

    normalize

    • normalize(): this

    • Normalize this. -Equivalent to Vec3.normalize(this, this);

      -

      Returns this

      this

      -

    scale

    • scale(b): this

    • Scales this by a scalar number. -Equivalent to Vec3.scale(this, this, b);

      -

      Parameters

      • b: number

        Amount to scale this by

        -

      Returns this

      this

      -

    scaleAndAdd

    • scaleAndAdd(b, scale): this

    • Calculates this scaled by a scalar value then adds the result to this. -Equivalent to Vec3.scaleAndAdd(this, this, b, scale);

      -

      Parameters

      • b: Readonly<Vec3Like>

        The vector to add to this

        -
      • scale: number

        The amount to scale b by before adding

        -

      Returns this

      this

      -

    sqrDist

    squaredDistance

    • squaredDistance(b): number

    • Calculates the squared Euclidean distance between another Vec3 and this. -Equivalent to Vec3.squaredDistance(this, b);

      -

      Parameters

      Returns number

      Squared distance between this and b

      -

    sub

    subtract

    • subtract(b): this

    • Subtracts a Vec3 from this. -Equivalent to Vec3.subtract(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Vec3.

      -

    Staticabs

    Staticadd

    Staticangle

    • angle(a, b): number

    • Get the angle between two 3D vectors

      -

      Parameters

      Returns number

      The angle in radians

      -

    Staticbezier

    Staticceil

    Staticclone

    • clone(a): Vec3

    • Creates a new vec3 initialized with values from an existing vector

      -

      Parameters

      Returns Vec3

      a new 3D vector

      -

    Staticcopy

    Staticcreate

    • create(): Vec3

    • Creates a new, empty vec3

      -

      Returns Vec3

      a new 3D vector

      -

    Staticcross

    Staticdist

    Staticdistance

    • distance(a, b): number

    • Calculates the Euclidean distance between two vec3's

      -

      Parameters

      Returns number

      distance between a and b

      -

    Staticdiv

    Staticdivide

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two vec3's

      -

      Parameters

      Returns number

      dot product of a and b

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether the vectors have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfloor

    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

      -

    Statichermite

    Staticinverse

    Staticlen

    Staticlength

    Staticlerp

    • lerp(out, a, b, t): Vec3Like

    • Performs a linear interpolation between two vec3's

      -

      Parameters

      Returns Vec3Like

      out

      -

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec3

      -

      Parameters

      Returns number

      Magnitude of a

      -

    Staticmax

    Staticmin

    Staticmul

    Staticmultiply

    Staticnegate

    Staticnormalize

    StaticrotateX

    StaticrotateY

    StaticrotateZ

    Staticscale

    • scale(out, a, scale): Vec3Like

    • Scales a vec3 by a scalar number

      -

      Parameters

      • out: Vec3Like

        the receiving vector

        -
      • a: Readonly<Vec3Like>

        the vector to scale

        -
      • scale: number

        amount to scale the vector by

        -

      Returns Vec3Like

      out

      -

    StaticscaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec3Like

    • Adds two vec3's after scaling the second operand by a scalar value

      -

      Parameters

      Returns Vec3Like

      out

      -

    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

      -

    Staticslerp

    • slerp(out, a, b, t): Vec3Like

    • Performs a spherical linear interpolation between two vec3's

      -

      Parameters

      Returns Vec3Like

      out

      -

    StaticsqrDist

    StaticsqrLen

    StaticsquaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared Euclidean distance between two vec3's

      -

      Parameters

      Returns number

      squared distance between a and b

      -

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a vec3

      -

      Parameters

      Returns number

      squared length of a

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a vector

      -

      Parameters

      Returns string

      string representation of the vector

      -

    Staticsub

    Staticsubtract

    StatictransformMat3

    • transformMat3(out, a, m): Vec3Like

    • Transforms the vec3 with a mat3.

      -

      Parameters

      Returns Vec3Like

      out

      -

    StatictransformMat4

    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

      -

    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];

      -

      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

    On This Page

    Accessors
    Color Components
    Constructor
    Methods
    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 deleted file mode 100644 index 6599621..0000000 --- a/docs/classes/_runtime_math_gl_matrix.Vec4.html +++ /dev/null @@ -1,493 +0,0 @@ -Vec4 | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Vec4

    4 Dimensional Vector

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Accessors

    mag -magnitude -str -

    Color Components

    a -b -g -r -

    Constructor

    constructor -

    Methods

    abs -add -copy -dist -distance -div -divide -dot -invert -mul -multiply -negate -normalize -scale -scaleAndAdd -sqrDist -squaredDistance -sub -subtract -

    Other

    [toStringTag] -buffer -byteLength -byteOffset -BYTES_PER_ELEMENT -length -BYTES_PER_ELEMENT -[iterator] -at -copyWithin -entries -every -fill -filter -find -findIndex -forEach -includes -indexOf -join -keys -lastIndexOf -map -reduce -reduceRight -reverse -set -slice -some -sort -subarray -toLocaleString -toString -valueOf -values -from -of -

    Static

    BYTE_LENGTH -abs -add -ceil -clone -copy -create -cross -dist -distance -div -divide -dot -equals -exactEquals -floor -fromValues -inverse -len -length -lerp -mag -magnitude -max -min -mul -multiply -negate -normalize -round -scale -scaleAndAdd -set -sqrDist -sqrLen -squaredDistance -squaredLength -str -sub -subtract -transformMat4 -transformQuat -zero -

    Vector Components

    w -x -y -z -

    Accessors

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

    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

    Constructor

    constructor

    Methods

    abs

    • abs(): this

    • Sets each component of this to it's absolute value. -Equivalent to Vec4.abs(this, this);

      -

      Returns this

      this

      -

    add

    • add(b): this

    • Adds a Vec4 to this. -Equivalent to Vec4.add(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    copy

    • copy(a): this

    • Copy the values from another Vec4 into this.

      -

      Parameters

      Returns this

      this

      -

    dist

    distance

    • distance(b): number

    • Calculates the Euclidean distance between another Vec4 and this. -Equivalent to Vec4.distance(this, b);

      -

      Parameters

      Returns number

      Distance between this and b

      -

    div

    divide

    • divide(b): this

    • Divides this by a Vec4. -Equivalent to Vec4.divide(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    dot

    • dot(b): number

    • Calculates the dot product of this and another Vec4. -Equivalent to Vec4.dot(this, b);

      -

      Parameters

      Returns number

      Dot product of this and b

      -

    invert

    • invert(): this

    • Inverts the components of this. -Equivalent to Vec4.inverse(this, this);

      -

      Returns this

      this

      -

    mul

    multiply

    • multiply(b): this

    • Multiplies this by a Vec4. -Equivalent to Vec4.multiply(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    negate

    • negate(): this

    • Negates the components of this. -Equivalent to Vec4.negate(this, this);

      -

      Returns this

      this

      -

    normalize

    • normalize(): this

    • Normalize this. -Equivalent to Vec4.normalize(this, this);

      -

      Returns this

      this

      -

    scale

    • scale(b): this

    • Scales this by a scalar number. -Equivalent to Vec4.scale(this, this, b);

      -

      Parameters

      • b: number

        Amount to scale this by

        -

      Returns this

      this

      -

    scaleAndAdd

    • scaleAndAdd(b, scale): this

    • Calculates this scaled by a scalar value then adds the result to this. -Equivalent to Vec4.scaleAndAdd(this, this, b, scale);

      -

      Parameters

      • b: Readonly<Vec4Like>

        The vector to add to this

        -
      • scale: number

        The amount to scale b by before adding

        -

      Returns this

      this

      -

    sqrDist

    squaredDistance

    • squaredDistance(b): number

    • Calculates the squared Euclidean distance between another Vec4 and this. -Equivalent to Vec4.squaredDistance(this, b);

      -

      Parameters

      Returns number

      Squared distance between this and b

      -

    sub

    subtract

    • subtract(b): this

    • Subtracts a Vec4 from this. -Equivalent to Vec4.subtract(this, this, b);

      -

      Parameters

      Returns this

      this

      -

    Other

    Readonly[toStringTag]

    [toStringTag]

    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.

    -

    [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

    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.

        -
      • Optionalend: number

        If not specified, length of the this object is used as its default value.

        -

      Returns this

    entries

    • entries(): ArrayIterator<[number, number]>

    • Returns an array of key, value pairs for every entry in the array

      -

      Returns ArrayIterator<[number, number]>

    every

    • every(predicate, thisArg?): boolean

    • Determines whether all the members of an array satisfy the specified test.

      -

      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

      • 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

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

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

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

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

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

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

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

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

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

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

      • 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: 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: 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: 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 -instead of an array value.

        -

      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: 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: 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: 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 -instead of an array value.

        -

      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.

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

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

      • 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

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

      • 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

    • toLocaleString(locales, options?): string

    • Parameters

      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

    • values(): ArrayIterator<number>

    • Returns an list of values in the array

      -

      Returns ArrayIterator<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: 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, any, any>

        An array-like or iterable object to convert to an array.

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

    StaticBYTE_LENGTH

    • get BYTE_LENGTH(): number

    • Returns number

      The number of bytes in a Vec4.

      -

    Staticabs

    Staticadd

    Staticceil

    Staticclone

    • clone(a): Vec4

    • Creates a new Vec4 initialized with values from an existing vector

      -

      Parameters

      Returns Vec4

      a new 4D vector

      -

    Staticcopy

    Staticcreate

    • create(): Vec4

    • Creates a new, empty Vec4

      -

      Returns Vec4

      a new 4D vector

      -

    Staticcross

    Staticdist

    Staticdistance

    • distance(a, b): number

    • Calculates the Euclidean distance between two Vec4's

      -

      Parameters

      Returns number

      distance between a and b

      -

    Staticdiv

    Staticdivide

    Staticdot

    • dot(a, b): number

    • Calculates the dot product of two Vec4's

      -

      Parameters

      Returns number

      dot product of a and b

      -

    Staticequals

    • equals(a, b): boolean

    • Returns whether the vectors have approximately the same elements in the same position.

      -

      Parameters

      Returns boolean

      True if the vectors are equal, false otherwise.

      -

    StaticexactEquals

    • exactEquals(a, b): boolean

    • Returns whether 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.

      -

    Staticfloor

    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

      -

    Staticinverse

    Staticlen

    Staticlength

    Staticlerp

    • lerp(out, a, b, t): Vec4Like

    • Performs a linear interpolation between two Vec4's

      -

      Parameters

      Returns Vec4Like

      out

      -

    Staticmag

    Staticmagnitude

    • magnitude(a): number

    • Calculates the magnitude (length) of a Vec4

      -

      Parameters

      Returns number

      length of a

      -

    Staticmax

    Staticmin

    Staticmul

    Staticmultiply

    Staticnegate

    Staticnormalize

    Staticround

    Staticscale

    StaticscaleAndAdd

    • scaleAndAdd(out, a, b, scale): Vec4Like

    • Adds two Vec4's after scaling the second operand by a scalar value

      -

      Parameters

      Returns Vec4Like

      out

      -

    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

      -

    StaticsqrDist

    StaticsqrLen

    StaticsquaredDistance

    • squaredDistance(a, b): number

    • Calculates the squared Euclidean distance between two Vec4's

      -

      Parameters

      Returns number

      squared distance between a and b

      -

    StaticsquaredLength

    • squaredLength(a): number

    • Calculates the squared length of a Vec4

      -

      Parameters

      Returns number

      squared length of a

      -

    Staticstr

    • str(a): string

    • Returns a string representation of a Vec4

      -

      Parameters

      Returns string

      string representation of the vector

      -

    Staticsub

    Staticsubtract

    StatictransformMat4

    StatictransformQuat

    Staticzero

    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

    On This Page

    Accessors
    Color Components
    Constructor
    Methods
    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 5717699..e021cb9 100644 --- a/docs/classes/_runtime_math_physics.TJSVelocityTrack.html +++ b/docs/classes/_runtime_math_physics.TJSVelocityTrack.html @@ -1,36 +1,36 @@ -TJSVelocityTrack | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSVelocityTrack

    Provides a way to calculate velocity via effectively creating a "complementary filter".

    +TJSVelocityTrack | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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 -

    Accessors

    resetDeltaTime -scaleTime +

    Accessors

    resetDeltaTime +scaleTime

    Methods

    get reset update -

    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 +

    Constructors

    constructor

    • new TJSVelocityTrack(
          opts?: { resetDeltaTime?: number; scaleTime?: number },
      ): 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.

      +

    Returns TJSVelocityTrack

    Accessors

    resetDeltaTime

    • get resetDeltaTime(): number

    • Returns number

      Gets resetDeltaTime.

      +
    • set resetDeltaTime(resetDeltaTime: number): 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.

      +

    Returns void

    scaleTime

    • get scaleTime(): number

    • Returns number

      Gets scaleTime.

      +
    • set scaleTime(scaleTime: number): 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 {
          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.

      +

    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.

      +

    reset

    • reset(x?: number, y?: number, z?: number, sampleTime?: number): void

    • Resets velocity tracking data.

      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.

      +

    Returns void

    update

    • update(
          x?: number,
          y?: number,
          z?: number,
          sampleTime?: number,
      ): { x: number; y: number; z: number }

    • Runs ongoing velocity calculation of x / y / z given a sample time.

      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

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns { x: number; y: number; z: number }

    current velocity.

    +

    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 c225272..9750ac7 100644 --- a/docs/classes/_runtime_math_util.MathRandom.html +++ b/docs/classes/_runtime_math_util.MathRandom.html @@ -1,21 +1,21 @@ -MathRandom | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class MathRandom

    Provides methods for retrieving pseudorandom values and other utilities using Math.random.

    +MathRandom | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class MathRandom

    Provides methods for retrieving pseudorandom values and other utilities using Math.random.

    Constructors

    constructor -

    Methods

    getBoolean -getFloat -getInt -shuffleArray -

    Constructors

    constructor

    Methods

    StaticgetBoolean

    • getBoolean(): boolean

    • Returns a random boolean.

      +

    Methods

    getBoolean +getFloat +getInt +shuffleArray +

    Constructors

    constructor

    Methods

    StaticgetBoolean

    • getBoolean(): boolean

    • Returns a random boolean.

      Returns boolean

      Random boolean.

      -

    StaticgetFloat

    • getFloat(min, max): number

    • Returns a random floating point number between min (inclusive) and max (exclusive).

      +

    StaticgetFloat

    • getFloat(min: number, max: number): 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.

      -

    StaticgetInt

    • getInt(min, max): number

    • Returns a random inclusive integer.

      +

    StaticgetInt

    • getInt(min: number, max: number): number

    • Returns a random inclusive integer.

      Parameters

      • min: number

        Minimum value.

      • max: number

        Maximum value.

      Returns number

      Random inclusive integer.

      -

    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

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    StaticshuffleArray

    • shuffleArray<T>(arr: T[]): 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

    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 e33c96e..fa2265c 100644 --- a/docs/classes/_runtime_plugin_manager.PluginInvokeEvent.html +++ b/docs/classes/_runtime_plugin_manager.PluginInvokeEvent.html @@ -1,20 +1,20 @@ -PluginInvokeEvent | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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 +PluginInvokeEvent | TyphonJS Runtime Library (FVTT) 0.2.0

    +

    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

    Properties

    data eventbus -pluginName -pluginOptions -

    Constructors

    constructor

    Constructors

    constructor

    • new PluginInvokeEvent(
          copyProps?: object,
          passthruProps?: object,
      ): 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

    On This Page

    Constructors
    Properties
    \ No newline at end of file +

    pluginName

    pluginName: string

    Unique data available in each plugin invoked.

    +

    pluginOptions

    pluginOptions: object

    Unique data available in each plugin invoked.

    +

    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 e6313f0..3e64ede 100644 --- a/docs/classes/_runtime_plugin_manager.PluginInvokeSupport.html +++ b/docs/classes/_runtime_plugin_manager.PluginInvokeSupport.html @@ -1,19 +1,19 @@ -PluginInvokeSupport | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class PluginInvokeSupport

    PluginInvokeSupport adds direct method invocation support to PluginManager via the eventbus and alternately through +PluginInvokeSupport | TyphonJS Runtime Library (FVTT) 0.2.0

    +

    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.

    TODO: more info and wiki link

    When added to a PluginManager through constructor initialization the following events are registered on the plugin manager eventbus:

    -

    plugins:async:invoke - PluginInvokeSupport#invokeAsync

    -

    plugins:async:invoke:event - PluginInvokeSupport#invokeAsyncEvent

    -

    plugins:get:method:names - PluginInvokeSupport#getMethodNames

    -

    plugins:has:method - PluginInvokeSupport#hasMethod

    +

    plugins:async:invoke - PluginInvokeSupport#invokeAsync

    +

    plugins:async:invoke:event - PluginInvokeSupport#invokeAsyncEvent

    +

    plugins:get:method:names - PluginInvokeSupport#getMethodNames

    +

    plugins:has:method - PluginInvokeSupport#hasMethod

    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.
+
    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.
    @@ -27,87 +27,87 @@

    Constructors

    constructor -

    Accessors

    isDestroyed +

    Accessors

    isDestroyed options -pluginManager +pluginManager

    Methods

    destroy -getMethodNames -hasMethod +getMethodNames +hasMethod invoke -invokeAsync -invokeAsyncEvent -invokeSync -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

    options

    pluginManager

    • get pluginManager(): PluginManager

    • Gets the associated plugin manager.

      +

    pluginManager

    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 +

    Methods

    destroy

    • destroy(opts: { eventbus: Eventbus; eventPrepend: string }): 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?: {
              enabled?: boolean;
              plugins?: string | Iterable<string, any, any>;
          },
      ): 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

      • Optionalopts: {
            enabled?: boolean;
            plugins?: string | Iterable<string, any, any>;
        }

        Options object. If undefined all plugin data is returned.

        -
        • Optionalenabled?: boolean

          If enabled is a boolean it will return plugin methods names +

          Parameters

          • Optionalopts: { enabled?: boolean; plugins?: string | Iterable<string, any, any> }

            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, any, any>

              Plugin name or iterable list of names.

              +
            • Optionalplugins?: string | Iterable<string, any, any>

              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, any, any>;
        }

        Options object.

        -
        • method: string

          Method name to test.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          Plugin name or iterable list of names to check for method. If +

    hasMethod

    • hasMethod(
          opts: { method: string; plugins?: string | Iterable<string, any, any> },
      ): boolean

    • Checks if the provided method name exists across all plugins or specific plugins if defined.

      +

      Parameters

      • opts: { method: string; plugins?: string | Iterable<string, any, any> }

        Options object.

        +
        • method: string

          Method name to test.

          +
        • Optionalplugins?: string | Iterable<string, any, any>

          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, any, any>;
        }

        Options object.

        -
        • Optionalargs?: any[]

          Method arguments. This array will be spread as multiple arguments.

          -
        • method: string

          Method name to invoke.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          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 +

    invoke

    • invoke(
          opts: {
              args?: any[];
              method: string;
              plugins?: string | Iterable<string, any, any>;
          },
      ): void

    • This dispatch method simply invokes any plugin targets for the given method name.

      +

      Parameters

      • opts: { args?: any[]; method: string; plugins?: string | Iterable<string, any, any> }

        Options object.

        +
        • Optionalargs?: any[]

          Method arguments. This array will be spread as multiple arguments.

          +
        • method: string

          Method name to invoke.

          +
        • Optionalplugins?: string | Iterable<string, any, any>

          Specific plugin name or iterable list of plugin names to invoke.

          +

      Returns void

    invokeAsync

    • invokeAsync(
          opts: {
              args?: any[];
              method: string;
              plugins?: string | Iterable<string, any, any>;
          },
      ): 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, any, any>;
        }

        Options object.

        -
        • Optionalargs?: any[]

          Method arguments. This array will be spread as multiple arguments.

          -
        • method: string

          Method name to invoke.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          Specific plugin name or iterable list of plugin names to invoke.

          +

          Parameters

          • opts: { args?: any[]; method: string; plugins?: string | Iterable<string, any, any> }

            Options object.

            +
            • Optionalargs?: any[]

              Method arguments. This array will be spread as multiple arguments.

              +
            • method: string

              Method name to invoke.

              +
            • Optionalplugins?: string | Iterable<string, any, any>

              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, any, any>;
        }

        Options object.

        -
        • OptionalcopyProps?: object

          Properties that are copied.

          -
        • method: string

          Method name to invoke.

          -
        • OptionalpassthruProps?: object

          Properties that are passed through.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          Specific plugin name or iterable list of plugin names to invoke.

          +

    invokeAsyncEvent

    • invokeAsyncEvent(
          opts: {
              copyProps?: object;
              method: string;
              passthruProps?: object;
              plugins?: string | Iterable<string, any, any>;
          },
      ): 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, any, any>;
        }

        Options object.

        +
        • OptionalcopyProps?: object

          Properties that are copied.

          +
        • method: string

          Method name to invoke.

          +
        • OptionalpassthruProps?: object

          Properties that are passed through.

          +
        • Optionalplugins?: string | Iterable<string, any, any>

          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 +

    invokeSync

    • invokeSync(
          opts: {
              args?: any[];
              method: string;
              plugins?: string | Iterable<string, any, any>;
          },
      ): 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, any, any>;
        }

        Options object.

        -
        • Optionalargs?: any[]

          Method arguments. This array will be spread as multiple arguments.

          -
        • method: string

          Method name to invoke.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          Specific plugin name or iterable list of plugin names to invoke.

          +

          Parameters

          • opts: { args?: any[]; method: string; plugins?: string | Iterable<string, any, any> }

            Options object.

            +
            • Optionalargs?: any[]

              Method arguments. This array will be spread as multiple arguments.

              +
            • method: string

              Method name to invoke.

              +
            • Optionalplugins?: string | Iterable<string, any, any>

              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, any, any>;
        }

        Options object.

        -
        • OptionalcopyProps?: object

          Properties that are copied.

          -
        • method: string

          Method name to invoke.

          -
        • OptionalpassthruProps?: object

          Properties that are passed through.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          Specific plugin name or iterable list of plugin names to invoke.

          +

    invokeSyncEvent

    • invokeSyncEvent(
          opts: {
              copyProps?: object;
              method: string;
              passthruProps?: object;
              plugins?: string | Iterable<string, any, any>;
          },
      ): 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, any, any>;
        }

        Options object.

        +
        • OptionalcopyProps?: object

          Properties that are copied.

          +
        • method: string

          Method name to invoke.

          +
        • OptionalpassthruProps?: object

          Properties that are passed through.

          +
        • Optionalplugins?: string | Iterable<string, any, any>

          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 +

    setEventbus

    • setEventbus(
          opts: {
              newEventbus: Eventbus;
              newPrepend: string;
              oldEventbus: Eventbus;
              oldPrepend: string;
          },
      ): 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: {
            newEventbus: Eventbus;
            newPrepend: string;
            oldEventbus: Eventbus;
            oldPrepend: string;
        }

        An options object.

        -
        • newEventbus: Eventbus

          The new eventbus to associate.

          -
        • newPrepend: string

          The new event prepend.

          -
        • oldEventbus: Eventbus

          The old eventbus to disassociate.

          -
        • oldPrepend: string

          The old event prepend.

          -

      Returns void

    setOptions

    • setOptions(options): void

    • Set optional parameters.

      +

      Parameters

      • opts: {
            newEventbus: Eventbus;
            newPrepend: string;
            oldEventbus: Eventbus;
            oldPrepend: string;
        }

        An options object.

        +
        • newEventbus: Eventbus

          The new eventbus to associate.

          +
        • newPrepend: string

          The new event prepend.

          +
        • oldEventbus: Eventbus

          The old eventbus to disassociate.

          +
        • oldPrepend: string

          The old event prepend.

          +

      Returns void

    setOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 6596fc7..7e4cc78 100644 --- a/docs/classes/_runtime_plugin_manager.PluginManager.html +++ b/docs/classes/_runtime_plugin_manager.PluginManager.html @@ -1,24 +1,24 @@ -PluginManager | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 plugin manager will register by default under these event categories:

    plugins:async:add - PluginManager#add

    -

    plugins:async:add:all - PluginManager#addAll

    +

    plugins:async:add:all - PluginManager#addAll

    plugins:async:destroy:manager - PluginManager#destroy

    plugins:async:remove - PluginManager#remove

    -

    plugins:async:remove:all - PluginManager#removeAll

    -

    plugins:get:enabled - PluginManager#getEnabled

    -

    plugins:get:options - PluginManager#getOptions

    -

    plugins:get:plugin:by:event - PluginManager#getPluginByEvent

    -

    plugins:get:plugin:data - PluginManager#getPluginData

    -

    plugins:get:plugin:events - PluginManager#getPluginEvents

    -

    plugins:get:plugin:names - PluginManager#getPluginNames

    -

    plugins:has:plugin - PluginManager#hasPlugins

    -

    plugins:is:valid:config - PluginManager#isValidConfig

    -

    plugins:set:enabled - PluginManager#setEnabled

    -

    plugins:set:options - PluginManager#setOptions

    +

    plugins:async:remove:all - PluginManager#removeAll

    +

    plugins:get:enabled - PluginManager#getEnabled

    +

    plugins:get:options - PluginManager#getOptions

    +

    plugins:get:plugin:by:event - PluginManager#getPluginByEvent

    +

    plugins:get:plugin:data - PluginManager#getPluginData

    +

    plugins:get:plugin:events - PluginManager#getPluginEvents

    +

    plugins:get:plugin:names - PluginManager#getPluginNames

    +

    plugins:has:plugin - PluginManager#hasPlugins

    +

    plugins:is:valid:config - PluginManager#isValidConfig

    +

    plugins:set:enabled - PluginManager#setEnabled

    +

    plugins:set:options - PluginManager#setOptions

    Automatically when a plugin is loaded and unloaded respective functions onPluginLoad and onPluginUnload will be attempted to be invoked on the plugin. This is an opportunity for the plugin to receive any associated eventbus and wire itself into it. It should be noted that a protected proxy around the eventbus is passed to the plugins @@ -43,138 +43,138 @@ 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);
+

    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 +

    Accessors

    isDestroyed

    Methods

    add -addAll -createEventbusProxy -createEventbusSecure +addAll +createEventbusProxy +createEventbusSecure destroy -getEnabled -getEventbus -getOptions -getPluginByEvent -getPluginData -getPluginEntry -getPluginEvents -getPluginMapKeys -getPluginMapValues -getPluginNames -hasPlugins -isValidConfig +getEnabled +getEventbus +getOptions +getPluginByEvent +getPluginData +getPluginEntry +getPluginEvents +getPluginMapKeys +getPluginMapValues +getPluginNames +hasPlugins +isValidConfig reload remove -removeAll -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: PluginConfig, moduleData?: object): 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.

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

        An iterable list of plugin config object hash entries.

        +

    addAll

    • addAll(
          pluginConfigs: Iterable<PluginConfig, any, any>,
          moduleData?: object,
      ): Promise<PluginData[]>

    • Initializes multiple plugins in a single call.

      +

      Parameters

      • pluginConfigs: Iterable<PluginConfig, any, any>

        An iterable list of plugin config object hash entries.

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

    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. +

    createEventbusSecure

    • createEventbusSecure(name?: string): 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

      • Optionalname: string

        Optional name for the EventbusSecure instance.

      Returns EventbusSecure

      A secure wrapper for the currently set Eventbus.

      -

    destroy

    destroy

    getEnabled

    • getEnabled(opts?): boolean | DataOutPluginEnabled[]

    • Returns the enabled state of a plugin, a list of plugins, or all plugins.

      -

      Parameters

      • Optionalopts: {
            plugins?: string | Iterable<string, any, any>;
        }

        Options object. If undefined all plugin enabled state is returned.

        -
        • Optionalplugins?: string | Iterable<string, any, any>

          Plugin name or iterable list of names to get state.

          -

      Returns boolean | DataOutPluginEnabled[]

      Enabled state for single plugin or array of results for multiple +

    getEnabled

    • getEnabled(
          opts?: { plugins?: string | Iterable<string, any, any> },
      ): boolean | DataOutPluginEnabled[]

    • Returns the enabled state of a plugin, a list of plugins, or all plugins.

      +

      Parameters

      • Optionalopts: { plugins?: string | Iterable<string, any, any> }

        Options object. If undefined all plugin enabled state is returned.

        +
        • Optionalplugins?: string | Iterable<string, any, any>

          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.

      -

    getEventbus

    • getEventbus(): Eventbus

    • Returns any associated eventbus.

      +

    getEventbus

    • getEventbus(): Eventbus

    • Returns any associated eventbus.

      Returns Eventbus

      The associated eventbus.

      -

    getOptions

    getOptions

    getPluginByEvent

    • getPluginByEvent(opts): string[] | DataOutPluginEvents[]

    • Returns the event binding names registered on any associated plugin EventbusProxy.

      -

      Parameters

      • opts: {
            event: string | RegExp;
        }

        Options object.

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

      • Optionalopts: {
            plugins?: string | Iterable<string, any, any>;
        }

        Options object. If undefined all plugin data is returned.

        -
        • Optionalplugins?: string | Iterable<string, any, any>

          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 +

    getPluginByEvent

    • getPluginByEvent(
          opts: { event: string | RegExp },
      ): string[] | DataOutPluginEvents[]

    • Returns the event binding names registered on any associated plugin EventbusProxy.

      +

      Parameters

      • opts: { event: string | RegExp }

        Options object.

        +
        • event: string | RegExp

          Event name or RegExp to match event names.

          +

      Returns string[] | DataOutPluginEvents[]

      Event binding names registered from the plugin.

      +

    getPluginData

    • getPluginData(
          opts?: { plugins?: string | Iterable<string, any, any> },
      ): PluginData | PluginData[]

    • Gets the plugin data for a plugin, list of plugins, or all plugins.

      +

      Parameters

      • Optionalopts: { plugins?: string | Iterable<string, any, any> }

        Options object. If undefined all plugin data is returned.

        +
        • Optionalplugins?: string | Iterable<string, any, any>

          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: string): 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

      • Optionalopts: {
            plugins?: string | Iterable<string, any, any>;
        }

        Options object. If undefined all plugin data is returned.

        -
        • Optionalplugins?: string | Iterable<string, any, any>

          Plugin name or iterable list of names to get plugin data.

          +

    getPluginEvents

    • getPluginEvents(
          opts?: { plugins?: string | Iterable<string, any, any> },
      ): DataOutPluginEvents[]

    • Returns the event binding names registered on any associated plugin EventbusProxy.

      +

      Parameters

      • Optionalopts: { plugins?: string | Iterable<string, any, any> }

        Options object. If undefined all plugin data is returned.

        +
        • Optionalplugins?: string | Iterable<string, any, any>

          Plugin name or iterable list of names to get plugin data.

      Returns DataOutPluginEvents[]

      Event binding names registered from the plugin.

      -

    getPluginMapKeys

    • getPluginMapKeys(): Iterable<string, any, any>

    • Returns an iterable of plugin map keys (plugin names). This method is primarily for PluginSupportImpl +

    getPluginMapKeys

    • getPluginMapKeys(): Iterable<string, any, any>

    • Returns an iterable of plugin map keys (plugin names). This method is primarily for PluginSupportImpl classes.

      -

      Returns Iterable<string, any, any>

      An iterable of plugin map keys.

      -

    getPluginMapValues

    • getPluginMapValues(): Iterable<PluginEntry, any, any>

    • Returns an iterable of plugin map keys (plugin names). This method is primarily for PluginSupportImpl +

      Returns Iterable<string, any, any>

      An iterable of plugin map keys.

      +

    getPluginMapValues

    • getPluginMapValues(): Iterable<PluginEntry, any, any>

    • Returns an iterable of plugin map keys (plugin names). This method is primarily for PluginSupportImpl classes.

      -

      Returns Iterable<PluginEntry, any, any>

      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

      • 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 Iterable<PluginEntry, any, any>

          An iterable of plugin map keys.

          +

    getPluginNames

    • getPluginNames(opts?: { enabled?: boolean }): string[]

    • Returns all plugin names or if enabled is set then return plugins matching the 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 +

    hasPlugins

    • hasPlugins(opts?: { plugins?: string | Iterable<string, any, any> }): 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

      • Optionalopts: {
            plugins?: string | Iterable<string, any, any>;
        }

        Options object. If undefined returns whether there are any plugins.

        -
        • Optionalplugins?: string | Iterable<string, any, any>

          Plugin name or iterable list of names to check existence.

          +

          Parameters

          • Optionalopts: { plugins?: string | Iterable<string, any, any> }

            Options object. If undefined returns whether there are any plugins.

            +
            • Optionalplugins?: string | Iterable<string, any, any>

              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.

      +

    isValidConfig

    • isValidConfig(pluginConfig: 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.

        -
        • Optionalinstance?: object

          Optional instance to replace.

          -
        • plugin: string

          Plugin name to reload.

          -
        • Optionalsilent?: boolean

          Does not trigger any reload notification on the eventbus.

          +

    reload

    • reload(
          opts: { instance?: object; plugin: string; silent?: boolean },
      ): Promise<boolean>

    • Unloads / reloads the plugin invoking onPluginUnload / then onPluginReload

      +

      Parameters

      • opts: { instance?: object; plugin: string; silent?: boolean }

        Options object.

        +
        • Optionalinstance?: object

          Optional instance to replace.

          +
        • plugin: string

          Plugin name to reload.

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

    remove

    • remove(
          opts: { plugins: string | Iterable<string, any, any> },
      ): Promise<DataOutPluginRemoved[]>

    • Removes a plugin by name or all names in an iterable list unloading them and clearing any event bindings automatically.

      -

      Parameters

      • opts: {
            plugins: string | Iterable<string, any, any>;
        }

        Options object.

        -
        • plugins: string | Iterable<string, any, any>

          Plugin name or iterable list of names to remove.

          +

          Parameters

          • opts: { plugins: string | Iterable<string, any, any> }

            Options object.

            +
            • plugins: string | Iterable<string, any, any>

              Plugin name or iterable list of names to remove.

          Returns Promise<DataOutPluginRemoved[]>

          A list of plugin names and removal success state.

          -

    removeAll

    removeAll

    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, any, any>;
        }

        Options object.

        -
        • enabled: boolean

          The enabled state.

          -
        • Optionalplugins?: string | Iterable<string, any, any>

          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 +

    setEnabled

    • setEnabled(
          opts: {
              enabled: boolean;
              plugins?: string | Iterable<string, any, any>;
          },
      ): void

    • Sets the enabled state of a plugin, a list of plugins, or all plugins.

      +

      Parameters

      • opts: { enabled: boolean; plugins?: string | Iterable<string, any, any> }

        Options object.

        +
        • enabled: boolean

          The enabled state.

          +
        • Optionalplugins?: string | Iterable<string, any, any>

          Plugin name or iterable list of names to set state.

          +

      Returns void

    setEventbus

    • setEventbus(opts: { eventbus: Eventbus; eventPrepend?: string }): 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: {
            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 +

          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.

      +

    Returns Promise<void>

    setOptions

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 132873a..b41b7ba 100644 --- a/docs/classes/_runtime_plugin_manager_eventbus.Eventbus.html +++ b/docs/classes/_runtime_plugin_manager_eventbus.Eventbus.html @@ -1,154 +1,154 @@ -Eventbus | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 -

    Accessors

    callbackCount -eventCount +

    Accessors

    callbackCount +eventCount name

    Methods

    before entries -getOptions -getType -isGuarded +getOptions +getType +isGuarded keys -keysWithOptions -listenTo -listenToBefore -listenToOnce +keysWithOptions +listenTo +listenToBefore +listenToOnce off on once -stopListening +stopListening trigger -triggerAsync -triggerDefer -triggerSync +triggerAsync +triggerDefer +triggerSync

    Properties

    _listeners -_listenId -_listeningTo -

    Constructors

    constructor

    Constructors

    constructor

    • new Eventbus(name?: string): 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 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.

      +

    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.

      +

    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: number,
          name: string | EventMap,
          callback: object | Function,
          context?: object,
          options?: EventOptions | EventOptionsOut,
      ): 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.

        +
      • name: string | EventMap

        Event name(s) or event map.

        +
      • callback: object | Function

        Event callback function or context for event map.

      • Optionalcontext: object

        Event context

        -
      • Optionaloptions: EventOptions | EventOptionsOut

        Event registration options.

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

      +

    entries

    • entries(
          regex?: RegExp,
      ): 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

      • Optionalregex: RegExp

        Optional regular expression to filter event names.

        -

      Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

      Generator

      -

      Yields

    getOptions

    Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    getOptions

    • getOptions(name: string): 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. +

    getType

    • getType(name: string): string

    • Returns the trigger type of event name. Note: if trigger type is not set then undefined is returned for type otherwise 'sync' or 'async' is returned.

      Parameters

      • name: string

        Event name(s) to verify.

      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.

        +

    isGuarded

    • isGuarded(name: string | EventMap, data?: object): boolean

    • Returns whether an event name is guarded.

      +

      Parameters

      • name: string | EventMap

        Event name(s) or event map to verify.

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

      +

    keys

    • keys(regex?: RegExp): Generator<string, void, unknown>

    • Returns an iterable for the event names / keys of registered event listeners.

      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.

      +

    Returns Generator<string, void, unknown>

    Yields

    keysWithOptions

    • keysWithOptions(
          regex?: RegExp,
      ): 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 +

    Returns Generator<[string, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    listenTo

    • listenTo(
          obj: object,
          name: string | EventMap,
          callback: object | Function,
      ): 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.

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

      +

    listenToBefore

    • listenToBefore(
          count: number,
          obj: object,
          name: string | EventMap,
          callback: object | Function,
      ): 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.

        -
      • name: string | EventMap

        Event name(s) or event map.

        -
      • callback: object | Function

        Event callback function or context for event map.

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

      -

    listenToOnce

    • listenToOnce(obj, name, callback): Eventbus

    • Just like listenTo, but causes the bound callback to fire only once before being removed.

      +

    listenToOnce

    • listenToOnce(
          obj: object,
          name: string | EventMap,
          callback: object | Function,
      ): Eventbus

    • Just like listenTo, but causes the bound callback to fire only once before being removed.

      Parameters

      • obj: object

        Target event context

        -
      • name: string | EventMap

        Event name(s) or event map.

        -
      • callback: object | Function

        Event callback function or context for event map.

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

      -

    off

    • off(name?, callback?, context?): Eventbus

    • Remove a previously-bound callback function from an object. If no context is specified, all the versions of +

    off

    • off(name?: string | EventMap, callback?: Function, context?: object): Eventbus

    • Remove a previously-bound callback function from an object. If no context is specified, all the versions of 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

      • Optionalname: string | EventMap

        Event name(s) or event map.

        +

        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 +

    on

    • on(
          name: string | EventMap,
          callback: object | Function,
          context?: object,
          options?: EventOptions | EventOptionsOut,
      ): 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'.

      To supply a context value for this when the callback is invoked, pass the optional last argument: 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.

        +

        Parameters

        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
        // 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
        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
        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 +

    once

    • once(
          name: string | EventMap,
          callback: object | Function,
          context?: object,
          options?: EventOptions | EventOptionsOut,
      ): 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.

        +

        Parameters

        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 +

    stopListening

    • stopListening(obj: object, name?: string, callback?: Function): 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

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

    trigger

    • trigger(name: string, ...args: any[]): 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).

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

    triggerAsync

    • triggerAsync(name: string, ...args: any[]): 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).

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

      +

    triggerDefer

    • triggerDefer(name: string, ...args: any[]): 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).

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

    triggerSync

    • triggerSync(name: string, ...args: any[]): 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).

        +
      • ...args: any[]

        Additional arguments passed to the event function(s).

      Returns any

      The results of the event invocation.

      -

    Properties

    _listeners

    _listeners: {}

    _listenId

    _listenId: string

    _listeningTo

    _listeningTo: {}

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    Properties
    \ 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 6e0b58c..b32e4cc 100644 --- a/docs/classes/_runtime_plugin_manager_eventbus.EventbusProxy.html +++ b/docs/classes/_runtime_plugin_manager_eventbus.EventbusProxy.html @@ -1,5 +1,5 @@ -EventbusProxy | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class EventbusProxy

    EventbusProxy provides a protected proxy of another Eventbus instance.

    +EventbusProxy | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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 @@ -14,131 +14,131 @@

    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 -

    Accessors

    callbackCount -eventCount -isDestroyed +

    Accessors

    callbackCount +eventCount +isDestroyed name -proxyCallbackCount -proxyEventCount +proxyCallbackCount +proxyEventCount

    Methods

    before -createProxy +createProxy destroy entries -getOptions -getType -isGuarded +getOptions +getType +isGuarded keys -keysWithOptions +keysWithOptions off on once -proxyEntries -proxyKeys -proxyKeysWithOptions +proxyEntries +proxyKeys +proxyKeysWithOptions trigger -triggerAsync -triggerDefer -triggerSync -

    Constructors

    constructor

    Constructors

    constructor

    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.

      +

    eventCount

    • get eventCount(): number

    • Returns the current proxied eventbus event count.

      Returns number

      Returns the current proxied event count.

      -

    isDestroyed

    • get isDestroyed(): boolean

    • Returns whether this EventbusProxy has already been destroyed.

      +

    isDestroyed

    • get isDestroyed(): boolean

    • Returns whether this EventbusProxy has already been destroyed.

      Returns boolean

      Is destroyed state.

      -

    name

    • get name(): string

    • Returns the target eventbus name.

      +

    name

    • get name(): string

    • Returns the target eventbus name.

      Returns string

      The target eventbus name.

      -

    proxyCallbackCount

    • get proxyCallbackCount(): number

    • Returns the current proxied callback count.

      +

    proxyCallbackCount

    • get proxyCallbackCount(): number

    • Returns the current proxied callback count.

      Returns number

      Returns the current proxied callback count.

      -

    proxyEventCount

    • get proxyEventCount(): number

    • Returns the current proxied event 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: number,
          name: string | EventMap,
          callback: object | Function,
          context?: object,
          options?: EventOptions | EventOptionsOut,
      ): 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.

        +
      • name: string | EventMap

        Event name(s) or event map.

        +
      • callback: object | Function

        Event callback function or context for event map.

      • Optionalcontext: object

        Event context

        -
      • Optionaloptions: EventOptions | EventOptionsOut

        Event registration options.

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

    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.

      Returns EventbusProxy

      A new EventbusProxy for this eventbus.

      -

    destroy

    • destroy(): void

    • Unregisters all proxied events from the target eventbus and removes any local references. All subsequent calls +

    destroy

    • destroy(): void

    • Unregisters all proxied events from the target eventbus and removes any local references. All subsequent calls 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, +

      Returns void

    entries

    • entries(
          regex?: RegExp,
      ): 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

      • Optionalregex: RegExp

        Optional regular expression to filter event names.

        -

      Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

      Generator

      -

      Yields

    getOptions

    Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    getOptions

    • getOptions(name: string): 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. +

    getType

    • getType(name: string): string

    • Returns the trigger type of event name. Note: if trigger type is not set then undefined is returned for type otherwise 'sync' or 'async' is returned.

      Parameters

      • name: string

        Event name(s) to verify.

      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.

        +

    isGuarded

    • isGuarded(name: string | EventMap, data?: object): boolean

    • Returns whether an event name is guarded.

      +

      Parameters

      • name: string | EventMap

        Event name(s) or event map to verify.

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

      +

    keys

    • keys(regex?: RegExp): Generator<string, void, unknown>

    • Returns an iterable for the event names / keys of proxied eventbus event listeners.

      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.

      +

    Returns Generator<string, void, unknown>

    Yields

    keysWithOptions

    • keysWithOptions(
          regex?: RegExp,
      ): 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.

      +

    Returns Generator<[string, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    off

    • off(
          name?: string | EventMap,
          callback?: Function,
          context?: object,
      ): EventbusProxy

    • Remove a previously-bound proxied event binding.

      Please see Eventbus#off.

      -

      Parameters

      • Optionalname: string | EventMap

        Event name(s) or event map.

        +

        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 +

    on

    • on(
          name: string | EventMap,
          callback: object | Function,
          context?: object,
          options?: EventOptions | EventOptionsOut,
      ): 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 change:selection.

      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.

        +

        Parameters

        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 +

    once

    • once(
          name: string | EventMap,
          callback: object | Function,
          context?: object,
          options?: EventOptions | EventOptionsOut,
      ): 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.

        +

        Parameters

        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 +

    proxyEntries

    • proxyEntries(
          regex?: RegExp,
      ): 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

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

      +

    Returns Generator<[string, Function, object, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    proxyKeys

    • proxyKeys(regex?: RegExp): 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.

      +

    Returns Generator<string, void, unknown>

    Yields

    proxyKeysWithOptions

    • proxyKeysWithOptions(
          regex?: RegExp,
      ): 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

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

    Returns Generator<[string, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    trigger

    • trigger(name: string, ...args: any[]): 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).

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

    triggerAsync

    • triggerAsync(name: string, ...args: any[]): 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).

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

      +

    triggerDefer

    • triggerDefer(name: string, ...args: any[]): 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).

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

    triggerSync

    • triggerSync(name: string, ...args: any[]): 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).

        +
      • ...args: any[]

        Additional arguments passed to the event function(s).

      Returns any

      An Array of returned results.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 e41d6f6..e13363c 100644 --- a/docs/classes/_runtime_plugin_manager_eventbus.EventbusSecure.html +++ b/docs/classes/_runtime_plugin_manager_eventbus.EventbusSecure.html @@ -1,5 +1,5 @@ -EventbusSecure | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class EventbusSecure

    EventbusSecure provides a secure wrapper around another Eventbus instance.

    +EventbusSecure | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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. @@ -8,59 +8,59 @@ contains two functions to control the secure eventbus externally; destroy and setEventbus. Expose to end consumers just the eventbusSecure instance.

    Constructors

    constructor -

    Accessors

    isDestroyed +

    Accessors

    isDestroyed name -

    Methods

    getOptions -getType +

    Methods

    getOptions +getType keys -keysWithOptions +keysWithOptions trigger -triggerAsync -triggerDefer -triggerSync +triggerAsync +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.

      +

    name

    • get name(): string

    • Returns the name associated with this instance.

      Returns string

      The target eventbus name.

      -

    Methods

    getOptions

    Methods

    getOptions

    • getOptions(name: string): 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. +

    getType

    • getType(name: string): string

    • Returns the trigger type of event name. Note: if trigger type is not set then undefined is returned for type otherwise 'sync' or 'async' is returned.

      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.

      +

    keys

    • keys(regex?: RegExp): Generator<string, void, unknown>

    • Returns an iterable for the event names / keys of secured eventbus event listeners.

      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.

      +

    Returns Generator<string, void, unknown>

    Yields

    keysWithOptions

    • keysWithOptions(
          regex?: RegExp,
      ): 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 +

    Returns Generator<[string, EventOptionsOut], void, unknown>

    Generator

    +

    Yields

    trigger

    • trigger(name: string, ...args: any[]): 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).

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

    triggerAsync

    • triggerAsync(name: string, ...args: any[]): 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).

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

      +

    triggerDefer

    • triggerDefer(name: string, ...args: any[]): 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).

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

    triggerSync

    • triggerSync(name: string, ...args: any[]): 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).

        +
      • ...args: any[]

        Additional arguments passed to the event function(s).

      Returns any

      An Array of returned results.

      -

    Staticinitialize

    • initialize(eventbus, name?): EventbusSecureObj

    • Creates the EventbusSecure instance with an existing instance of Eventbus. An object / EventbusSecureObj is +

    Staticinitialize

    • initialize(eventbus: EventbusProxy | Eventbus, name?: string): 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.

        +

        Parameters

        • eventbus: EventbusProxy | Eventbus

          The target eventbus instance.

        • 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

    On This Page

    Constructors
    Accessors
    Methods
    \ 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_animate_gsap.GsapCompose.html b/docs/classes/_runtime_svelte_animate_gsap.GsapCompose.html index 6dbbd9a..c5895a0 100644 --- a/docs/classes/_runtime_svelte_animate_gsap.GsapCompose.html +++ b/docs/classes/_runtime_svelte_animate_gsap.GsapCompose.html @@ -1,51 +1,51 @@ -GsapCompose | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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
    +

    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

    Methods

    from -fromTo -hasMethod -quickTo -registerEase -registerPlugin +fromTo +hasMethod +quickTo +registerEase +registerPlugin timeline to -

    Constructors

    constructor

    Methods

    Staticfrom

    • from(target, vars, options?): object

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

        +

    Constructors

    constructor

    Methods

    Staticfrom

    • from(target: GsapTarget, vars: object, options?: GsapPositionOptions): object

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

      • vars: object

        GSAP vars object for from.

      • Optionaloptions: GsapPositionOptions

        Options for filtering and initial data population for TJSPosition tweens.

      Returns object

      GSAP tween

      -

    StaticfromTo

    • fromTo(target, fromVars, toVars, options?): object

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

        +

    StaticfromTo

    • fromTo(
          target: GsapTarget,
          fromVars: object,
          toVars: object,
          options?: GsapPositionOptions,
      ): object

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

      • fromVars: object

        GSAP fromVars object for fromTo

      • toVars: object

        GSAP toVars object for fromTo.

      • Optionaloptions: GsapPositionOptions

        Options for filtering and initial data population.

      Returns object

      GSAP tween

      -

    StatichasMethod

    • hasMethod(name): boolean

    • Checks the gsap module instance for existence of a method and GsapCompose for the same method name. This +

    StatichasMethod

    • hasMethod(name: string): 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.

      -

    StaticquickTo

    • quickTo(target, key, vars, options?): Function

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

        +

    StaticquickTo

    • quickTo(
          target: GsapTarget,
          key: string,
          vars: object,
          options?: GsapPositionOptions,
      ): Function

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

      • key: string

        Property of position to manipulate.

      • vars: object

        GSAP vars object for quickTo.

      • Optionaloptions: GsapPositionOptions

        Options for filtering and initial data population.

      Returns Function

      GSAP quickTo function.

      -

    StaticregisterEase

    • registerEase(name, ease): void

    • Defers to gsap module to register an easing function.

      +

    StaticregisterEase

    • registerEase(name: string, ease: Function): void

    • Defers to gsap module to register an easing function.

      Parameters

      • name: string

        Easing name.

      • ease: Function

        An easing function.

        -

      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 +

      Returns void

    StaticregisterPlugin

    • registerPlugin(...args: Function[]): void

    • Defers to gsap module to register a plugin.

      +

      Parameters

      Returns void

    Statictimeline

    Staticto

    • to(target, vars, options?): object

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

        +

    Staticto

    • to(target: GsapTarget, vars: object, options?: GsapPositionOptions): object

    • Parameters

      • target: GsapTarget

        A standard GSAP target or TJSPosition.

      • vars: object

        GSAP vars object for to.

      • Optionaloptions: GsapPositionOptions

        Options for filtering and initial data population.

      Returns object

      GSAP tween

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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_application.SvelteApplication.html b/docs/classes/_runtime_svelte_application.SvelteApplication.html index c87d1a5..459436c 100644 --- a/docs/classes/_runtime_svelte_application.SvelteApplication.html +++ b/docs/classes/_runtime_svelte_application.SvelteApplication.html @@ -1,7 +1,7 @@ -SvelteApplication | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 +TJSSvelteConfig object in the SvelteApplicationOptions options SvelteApplicationOptions.svelte property.

    @@ -21,54 +21,54 @@
    Hierarchy
    -
    +

    Constructors

    constructor -

    Accessors

    elementContent -elementTarget +

    Accessors

    elementContent +elementTarget position reactive state svelte

    Methods

    maximize minimize -onSvelteMount -onSvelteRemount -

    Constructors

    constructor

    Accessors

    elementContent

    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.

      +

    elementTarget

    • get elementTarget(): HTMLElement

    • Returns the target element or main element if no target defined.

      Returns HTMLElement

      Target element.

      -

    position

    • get position(): TJSPosition

    • Returns the TJSPosition instance.

      +

    position

    reactive

    reactive

    • get reactive(): SvelteReactive

    • Returns the reactive accessors & Svelte stores for SvelteApplication.

      Returns SvelteReactive

      The reactive accessors & Svelte stores.

      -

    state

    state

    svelte

    • get svelte(): GetSvelteData

    • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

      +

    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?: { animate?: boolean; duration?: number }): 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

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

      +

      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?: { animate?: boolean; duration?: number }): 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

      • 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

      • 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?: MountedAppShell): void

    • Provides a callback after all Svelte components are initialized.

      Parameters

      Returns void

    onSvelteRemount

    • onSvelteRemount(mountedAppShell?): void

    • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

    Returns void

    onSvelteRemount

    • onSvelteRemount(mountedAppShell?: 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

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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_application.TJSDialog.html b/docs/classes/_runtime_svelte_application.TJSDialog.html index cb04114..00d8f2c 100644 --- a/docs/classes/_runtime_svelte_application.TJSDialog.html +++ b/docs/classes/_runtime_svelte_application.TJSDialog.html @@ -1,5 +1,5 @@ -TJSDialog | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 @@ -11,7 +11,7 @@ can set autoClose: false, however you are 100% in control of resolving any Promise callbacks from button presses and also closing the application. Each button can also be configured with autoClose: false in the button data.

    There is a handy Promise management capability to track a single Promise for the lifetime of a dialog available -at TJSDialog.managedPromise. By default when the user closes the dialog / application any managed Promise is +at TJSDialog.managedPromise. By default when the user closes the dialog / application any managed Promise is resolved with null. The managed Promise is available in any Svelte content component by using const managedPromise = getContext('#managedPromise'). When handling any custom resolution particularly when setting autoClose: false for a given button you are 100% in control of resolving or rejecting asynchronous data to @@ -29,99 +29,110 @@

    Hierarchy
    -
    +

    Constructors

    constructor

    Accessors

    data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

    Methods

    maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm prompt wait -

    Constructors

    constructor

    Constructors

    constructor

    Accessors

    data

    Returns TJSDialog

    Accessors

    data

    elementContent

    • get elementContent(): HTMLElement

    • Returns the content element if an application shell is mounted.

      +

    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.

      +

    elementTarget

    • get elementTarget(): HTMLElement

    • Returns the target element or main element if no target defined.

      Returns HTMLElement

      Target element.

      -

    managedPromise

    position

    • get position(): TJSPosition

    • Returns the TJSPosition instance.

      +

    managedPromise

    position

    • get position(): TJSPosition

    • Returns the TJSPosition instance.

      Returns TJSPosition

      The TJSPosition instance.

      -

    reactive

    • get reactive(): SvelteReactive

    • Returns the reactive accessors & Svelte stores for SvelteApplication.

      +

    reactive

    • get reactive(): SvelteReactive

    • Returns the reactive accessors & Svelte stores for SvelteApplication.

      Returns SvelteReactive

      The reactive accessors & Svelte stores.

      -

    state

    • get state(): ApplicationState

    • Returns the application state manager.

      +

    state

    • get state(): ApplicationState

    • Returns the application state manager.

      Returns ApplicationState

      The application state manager.

      -

    svelte

    • get svelte(): GetSvelteData

    • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

      +

    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?: { animate?: boolean; duration?: number }): 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

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

      +

      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?: { animate?: boolean; duration?: number }): 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

      • 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

      • 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

    onSvelteRemount

    • onSvelteRemount(mountedAppShell?): void

    • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

    Returns void

    onSvelteRemount

    • onSvelteRemount(mountedAppShell?: 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

      Returns void

    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 +

    Returns void

    wait

    • wait<T>(options?: { reuse?: boolean }): 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

      • Optionaloptions: {
            reuse?: boolean;
        }

        Options.

        -
        • Optionalreuse?: boolean

          When true if there is an existing managed Promise this allows multiple +

          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.

          -

    Staticconfirm

    • confirm<T>(data?, options?): Promise<T>

    • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

    Returns Promise<T>

    A promise for dialog resolution.

    +

    Staticconfirm

    • confirm<T>(
          data?: TJSDialogOptions & {
              onNo?: string | (data?: { application?: TJSDialog }) => any;
              onYes?: string | (data?: { application?: TJSDialog }) => any;
          },
          options?: SvelteApplicationOptions,
      ): Promise<T>

    • 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

      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 +

        Type Parameters

        • T

        Parameters

        • Optionaldata: TJSDialogOptions & {
              onNo?: string | (data?: { application?: TJSDialog }) => any;
              onYes?: string | (data?: { application?: TJSDialog }) => any;
          }

          Confirm dialog options.

          +
          • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
          • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        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);
+

      Returns Promise<T>

      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);
      -

    Staticprompt

    • prompt<T>(data?, options?): Promise<T>

    • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

      -

      Type Parameters

      • T

      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 +

    Staticprompt

    • prompt<T>(
          data?: TJSDialogOptions & {
              icon?: string;
              label?: string;
              onOk?: string | (data?: { application?: TJSDialog }) => any;
          },
          options?: SvelteApplicationOptions,
      ): Promise<T>

    • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

      +

      Type Parameters

      • T

      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:

        +
        • Optionalicon?: string

          Set another icon besides fas fa-check for button.

          +
        • Optionallabel?: string

          The OK prompt button text.

          +
        • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

          Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

          +
      • Optionaloptions: SvelteApplicationOptions

        SvelteApplication options passed to the TJSDialog constructor.

        -

      Returns Promise<T>

      The returned value from the provided callback function or true if the button +

    Returns Promise<T>

    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);
+
    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>(data, options?): Promise<T>

    • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

    Staticwait

    • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

    • 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

      Parameters

      • data: TJSDialogOptions

        Dialog data passed to the TJSDialog constructor.

        +

        Type Parameters

        • T

        Parameters

        Returns Promise<T>

        A Promise that resolves to the chosen result.

        -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns Promise<T>

    A Promise that resolves to the chosen result.

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_svelte_component_application.ApplicationShell.html b/docs/classes/_runtime_svelte_component_application.ApplicationShell.html index fb2ebed..57e01fb 100644 --- a/docs/classes/_runtime_svelte_component_application.ApplicationShell.html +++ b/docs/classes/_runtime_svelte_component_application.ApplicationShell.html @@ -1,5 +1,5 @@ -ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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.

    @@ -9,58 +9,58 @@
    Hierarchy
    -
    +
    -

    Constructors

    constructor -

    Accessors

    appOffsetHeight -appOffsetWidth -contentOffsetHeight -contentOffsetWidth +

    Indexable

    • [prop: string]: any

    Constructors

    constructor +

    Accessors

    appOffsetHeight +appOffsetWidth +contentOffsetHeight +contentOffsetWidth draggable -draggableOptions -elementContent -elementRoot -inTransition -inTransitionOptions -outTransition -outTransitionOptions -stylesApp -stylesContent +draggableOptions +elementContent +elementRoot +inTransition +inTransitionOptions +outTransition +outTransitionOptions +stylesApp +stylesContent transition -transitionOptions -

    Methods

    $destroy -$on -$set -

    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.

      -

      Parameters

      • _: boolean

      Returns void

    contentOffsetHeight

    contentOffsetWidth

    • get contentOffsetWidth(): boolean

    • Getter for contentOffsetWidth prop.

      -

      Returns boolean

    • set contentOffsetWidth(_): void

    • Setter for contentOffsetWidth prop.

      -

      Parameters

      • _: boolean

      Returns void

    draggable

    • get draggable(): any

    • Getter for draggable prop.

      -

      Returns any

    • set draggable(_): void

    • Setter for draggable prop.

      -

      Parameters

      • _: any

      Returns void

    draggableOptions

    • get draggableOptions(): any

    • Getter for draggableOptions prop.

      -

      Returns any

    • set draggableOptions(_): void

    • Setter for draggableOptions prop.

      -

      Parameters

      • _: any

      Returns void

    elementContent

    • get elementContent(): any

    • Getter for elementContent prop.

      -

      Returns any

    • set elementContent(_): void

    • Setter for elementContent prop.

      -

      Parameters

      • _: any

      Returns void

    elementRoot

    • get elementRoot(): any

    • Getter for elementRoot prop.

      -

      Returns any

    • set elementRoot(_): void

    • Setter for elementRoot prop.

      -

      Parameters

      • _: any

      Returns void

    inTransition

    • get inTransition(): (() => undefined)

    • Getter for inTransition prop.

      -

      Returns (() => undefined)

        • (): undefined

        • Returns undefined

    • set inTransition(_): void

    • Setter for inTransition prop.

      -

      Parameters

      • _: (() => undefined)
          • (): undefined

          • Returns undefined

      Returns void

    inTransitionOptions

    outTransition

    • get outTransition(): (() => undefined)

    • Getter for outTransition prop.

      -

      Returns (() => undefined)

        • (): undefined

        • Returns undefined

    • set outTransition(_): void

    • Setter for outTransition prop.

      -

      Parameters

      • _: (() => undefined)
          • (): undefined

          • Returns undefined

      Returns void

    outTransitionOptions

    stylesApp

    • get stylesApp(): any

    • Getter for stylesApp prop.

      -

      Returns any

    • set stylesApp(_): void

    • Setter for stylesApp prop.

      -

      Parameters

      • _: any

      Returns void

    stylesContent

    • get stylesContent(): any

    • Getter for stylesContent prop.

      -

      Returns any

    • set stylesContent(_): void

    • Setter for stylesContent prop.

      -

      Parameters

      • _: any

      Returns void

    transition

    • get transition(): (() => undefined)

    • Getter for transition prop.

      -

      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

      Returns (() => void)

        • (): void

        • Returns void

    $set

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +transitionOptions +

    Methods

    $destroy +$on +$set +

    Constructors

    constructor

    Accessors

    appOffsetHeight

    • get appOffsetHeight(): boolean

    • Getter for appOffsetHeight prop.

      +

      Returns boolean

    • set appOffsetHeight(_: boolean): void

    • Setter for appOffsetHeight prop.

      +

      Parameters

      • _: boolean

      Returns void

    appOffsetWidth

    • get appOffsetWidth(): boolean

    • Getter for appOffsetWidth prop.

      +

      Returns boolean

    • set appOffsetWidth(_: boolean): void

    • Setter for appOffsetWidth prop.

      +

      Parameters

      • _: boolean

      Returns void

    contentOffsetHeight

    • get contentOffsetHeight(): boolean

    • Getter for contentOffsetHeight prop.

      +

      Returns boolean

    • set contentOffsetHeight(_: boolean): void

    • Setter for contentOffsetHeight prop.

      +

      Parameters

      • _: boolean

      Returns void

    contentOffsetWidth

    • get contentOffsetWidth(): boolean

    • Getter for contentOffsetWidth prop.

      +

      Returns boolean

    • set contentOffsetWidth(_: boolean): void

    • Setter for contentOffsetWidth prop.

      +

      Parameters

      • _: boolean

      Returns void

    draggable

    • get draggable(): any

    • Getter for draggable prop.

      +

      Returns any

    • set draggable(_: any): void

    • Setter for draggable prop.

      +

      Parameters

      • _: any

      Returns void

    draggableOptions

    • get draggableOptions(): any

    • Getter for draggableOptions prop.

      +

      Returns any

    • set draggableOptions(_: any): void

    • Setter for draggableOptions prop.

      +

      Parameters

      • _: any

      Returns void

    elementContent

    • get elementContent(): any

    • Getter for elementContent prop.

      +

      Returns any

    • set elementContent(_: any): void

    • Setter for elementContent prop.

      +

      Parameters

      • _: any

      Returns void

    elementRoot

    • get elementRoot(): any

    • Getter for elementRoot prop.

      +

      Returns any

    • set elementRoot(_: any): void

    • Setter for elementRoot prop.

      +

      Parameters

      • _: any

      Returns void

    inTransition

    • get inTransition(): () => undefined

    • Getter for inTransition prop.

      +

      Returns () => undefined

    • set inTransition(_: () => undefined): void

    • Setter for inTransition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    inTransitionOptions

    outTransition

    • get outTransition(): () => undefined

    • Getter for outTransition prop.

      +

      Returns () => undefined

    • set outTransition(_: () => undefined): void

    • Setter for outTransition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    outTransitionOptions

    stylesApp

    • get stylesApp(): any

    • Getter for stylesApp prop.

      +

      Returns any

    • set stylesApp(_: any): void

    • Setter for stylesApp prop.

      +

      Parameters

      • _: any

      Returns void

    stylesContent

    • get stylesContent(): any

    • Getter for stylesContent prop.

      +

      Returns any

    • set stylesContent(_: any): void

    • Setter for stylesContent prop.

      +

      Parameters

      • _: any

      Returns void

    transition

    • get transition(): () => undefined

    • Getter for transition prop.

      +

      Returns () => undefined

    • set transition(_: () => undefined): void

    • Setter for transition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    transitionOptions

    • get transitionOptions(): any

    • Getter for transitionOptions prop.

      +

      Returns any

    • set transitionOptions(_: any): void

    • Setter for transitionOptions prop.

      +

      Parameters

      • _: any

      Returns void

    Methods

    $destroy

    $on

    • $on<K extends string>(
          type: K,
          callback: (e: CustomEvent<any>) => void,
      ): () => void

    • Type Parameters

      • K extends string

      Parameters

      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_application.EmptyApplicationShell.html b/docs/classes/_runtime_svelte_component_application.EmptyApplicationShell.html index e6eb9ba..07edd3a 100644 --- a/docs/classes/_runtime_svelte_component_application.EmptyApplicationShell.html +++ b/docs/classes/_runtime_svelte_component_application.EmptyApplicationShell.html @@ -1,5 +1,5 @@ -EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class EmptyApplicationShell

    Provides an empty application shell as a main top level slotted component.

    +EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class EmptyApplicationShell

    Provides an empty application shell as a main top level slotted component.

    @@ -8,43 +8,43 @@
    Hierarchy
    -
    +
    -

    Constructors

    constructor -

    Accessors

    appOffsetHeight -appOffsetWidth -elementContent -elementRoot -inTransition -inTransitionOptions -outTransition -outTransitionOptions -stylesApp +

    Indexable

    • [prop: string]: any

    Constructors

    constructor +

    Accessors

    appOffsetHeight +appOffsetWidth +elementContent +elementRoot +inTransition +inTransitionOptions +outTransition +outTransitionOptions +stylesApp transition -transitionOptions -

    Methods

    $destroy -$on -$set -

    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.

      -

      Parameters

      • _: boolean

      Returns void

    elementContent

    • get elementContent(): any

    • Getter for elementContent prop.

      -

      Returns any

    • set elementContent(_): void

    • Setter for elementContent prop.

      -

      Parameters

      • _: any

      Returns void

    elementRoot

    • get elementRoot(): any

    • Getter for elementRoot prop.

      -

      Returns any

    • set elementRoot(_): void

    • Setter for elementRoot prop.

      -

      Parameters

      • _: any

      Returns void

    inTransition

    • get inTransition(): (() => undefined)

    • Getter for inTransition prop.

      -

      Returns (() => undefined)

        • (): undefined

        • Returns undefined

    • set inTransition(_): void

    • Setter for inTransition prop.

      -

      Parameters

      • _: (() => undefined)
          • (): undefined

          • Returns undefined

      Returns void

    inTransitionOptions

    outTransition

    • get outTransition(): (() => undefined)

    • Getter for outTransition prop.

      -

      Returns (() => undefined)

        • (): undefined

        • Returns undefined

    • set outTransition(_): void

    • Setter for outTransition prop.

      -

      Parameters

      • _: (() => undefined)
          • (): undefined

          • Returns undefined

      Returns void

    outTransitionOptions

    stylesApp

    • get stylesApp(): any

    • Getter for stylesApp prop.

      -

      Returns any

    • set stylesApp(_): void

    • Setter for stylesApp prop.

      -

      Parameters

      • _: any

      Returns void

    transition

    • get transition(): (() => undefined)

    • Getter for transition prop.

      -

      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

      Returns (() => void)

        • (): void

        • Returns void

    $set

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +transitionOptions +

    Methods

    $destroy +$on +$set +

    Constructors

    constructor

    Accessors

    appOffsetHeight

    • get appOffsetHeight(): boolean

    • Getter for appOffsetHeight prop.

      +

      Returns boolean

    • set appOffsetHeight(_: boolean): void

    • Setter for appOffsetHeight prop.

      +

      Parameters

      • _: boolean

      Returns void

    appOffsetWidth

    • get appOffsetWidth(): boolean

    • Getter for appOffsetWidth prop.

      +

      Returns boolean

    • set appOffsetWidth(_: boolean): void

    • Setter for appOffsetWidth prop.

      +

      Parameters

      • _: boolean

      Returns void

    elementContent

    • get elementContent(): any

    • Getter for elementContent prop.

      +

      Returns any

    • set elementContent(_: any): void

    • Setter for elementContent prop.

      +

      Parameters

      • _: any

      Returns void

    elementRoot

    • get elementRoot(): any

    • Getter for elementRoot prop.

      +

      Returns any

    • set elementRoot(_: any): void

    • Setter for elementRoot prop.

      +

      Parameters

      • _: any

      Returns void

    inTransition

    • get inTransition(): () => undefined

    • Getter for inTransition prop.

      +

      Returns () => undefined

    • set inTransition(_: () => undefined): void

    • Setter for inTransition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    inTransitionOptions

    outTransition

    • get outTransition(): () => undefined

    • Getter for outTransition prop.

      +

      Returns () => undefined

    • set outTransition(_: () => undefined): void

    • Setter for outTransition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    outTransitionOptions

    stylesApp

    • get stylesApp(): any

    • Getter for stylesApp prop.

      +

      Returns any

    • set stylesApp(_: any): void

    • Setter for stylesApp prop.

      +

      Parameters

      • _: any

      Returns void

    transition

    • get transition(): () => undefined

    • Getter for transition prop.

      +

      Returns () => undefined

    • set transition(_: () => undefined): void

    • Setter for transition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    transitionOptions

    • get transitionOptions(): any

    • Getter for transitionOptions prop.

      +

      Returns any

    • set transitionOptions(_: any): void

    • Setter for transitionOptions prop.

      +

      Parameters

      • _: any

      Returns void

    Methods

    $destroy

    $on

    • $on<K extends string>(
          type: K,
          callback: (e: CustomEvent<any>) => void,
      ): () => void

    • Type Parameters

      • K extends string

      Parameters

      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_application.TJSApplicationShell.html b/docs/classes/_runtime_svelte_component_application.TJSApplicationShell.html index d7c3c0b..2d0b971 100644 --- a/docs/classes/_runtime_svelte_component_application.TJSApplicationShell.html +++ b/docs/classes/_runtime_svelte_component_application.TJSApplicationShell.html @@ -1,8 +1,8 @@ -TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSApplicationShell

    Provides an alternate application shell that is scoped by slightly different CSS classes than +TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0

    +

    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`.
    @@ -13,58 +13,58 @@
    Hierarchy
    -
    +
    -

    Constructors

    constructor -

    Accessors

    appOffsetHeight -appOffsetWidth -contentOffsetHeight -contentOffsetWidth +

    Indexable

    • [prop: string]: any

    Constructors

    constructor +

    Accessors

    appOffsetHeight +appOffsetWidth +contentOffsetHeight +contentOffsetWidth draggable -draggableOptions -elementContent -elementRoot -inTransition -inTransitionOptions -outTransition -outTransitionOptions -stylesApp -stylesContent +draggableOptions +elementContent +elementRoot +inTransition +inTransitionOptions +outTransition +outTransitionOptions +stylesApp +stylesContent transition -transitionOptions -

    Methods

    $destroy -$on -$set -

    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.

      -

      Parameters

      • _: boolean

      Returns void

    contentOffsetHeight

    contentOffsetWidth

    • get contentOffsetWidth(): boolean

    • Getter for contentOffsetWidth prop.

      -

      Returns boolean

    • set contentOffsetWidth(_): void

    • Setter for contentOffsetWidth prop.

      -

      Parameters

      • _: boolean

      Returns void

    draggable

    • get draggable(): any

    • Getter for draggable prop.

      -

      Returns any

    • set draggable(_): void

    • Setter for draggable prop.

      -

      Parameters

      • _: any

      Returns void

    draggableOptions

    • get draggableOptions(): any

    • Getter for draggableOptions prop.

      -

      Returns any

    • set draggableOptions(_): void

    • Setter for draggableOptions prop.

      -

      Parameters

      • _: any

      Returns void

    elementContent

    • get elementContent(): any

    • Getter for elementContent prop.

      -

      Returns any

    • set elementContent(_): void

    • Setter for elementContent prop.

      -

      Parameters

      • _: any

      Returns void

    elementRoot

    • get elementRoot(): any

    • Getter for elementRoot prop.

      -

      Returns any

    • set elementRoot(_): void

    • Setter for elementRoot prop.

      -

      Parameters

      • _: any

      Returns void

    inTransition

    • get inTransition(): (() => undefined)

    • Getter for inTransition prop.

      -

      Returns (() => undefined)

        • (): undefined

        • Returns undefined

    • set inTransition(_): void

    • Setter for inTransition prop.

      -

      Parameters

      • _: (() => undefined)
          • (): undefined

          • Returns undefined

      Returns void

    inTransitionOptions

    outTransition

    • get outTransition(): (() => undefined)

    • Getter for outTransition prop.

      -

      Returns (() => undefined)

        • (): undefined

        • Returns undefined

    • set outTransition(_): void

    • Setter for outTransition prop.

      -

      Parameters

      • _: (() => undefined)
          • (): undefined

          • Returns undefined

      Returns void

    outTransitionOptions

    stylesApp

    • get stylesApp(): any

    • Getter for stylesApp prop.

      -

      Returns any

    • set stylesApp(_): void

    • Setter for stylesApp prop.

      -

      Parameters

      • _: any

      Returns void

    stylesContent

    • get stylesContent(): any

    • Getter for stylesContent prop.

      -

      Returns any

    • set stylesContent(_): void

    • Setter for stylesContent prop.

      -

      Parameters

      • _: any

      Returns void

    transition

    • get transition(): (() => undefined)

    • Getter for transition prop.

      -

      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

      Returns (() => void)

        • (): void

        • Returns void

    $set

    Settings

    Member Visibility

    On This Page

    CSS variables
    Constructors
    Accessors
    Methods
    \ No newline at end of file +transitionOptions +

    Methods

    $destroy +$on +$set +

    Constructors

    constructor

    Accessors

    appOffsetHeight

    • get appOffsetHeight(): boolean

    • Getter for appOffsetHeight prop.

      +

      Returns boolean

    • set appOffsetHeight(_: boolean): void

    • Setter for appOffsetHeight prop.

      +

      Parameters

      • _: boolean

      Returns void

    appOffsetWidth

    • get appOffsetWidth(): boolean

    • Getter for appOffsetWidth prop.

      +

      Returns boolean

    • set appOffsetWidth(_: boolean): void

    • Setter for appOffsetWidth prop.

      +

      Parameters

      • _: boolean

      Returns void

    contentOffsetHeight

    • get contentOffsetHeight(): boolean

    • Getter for contentOffsetHeight prop.

      +

      Returns boolean

    • set contentOffsetHeight(_: boolean): void

    • Setter for contentOffsetHeight prop.

      +

      Parameters

      • _: boolean

      Returns void

    contentOffsetWidth

    • get contentOffsetWidth(): boolean

    • Getter for contentOffsetWidth prop.

      +

      Returns boolean

    • set contentOffsetWidth(_: boolean): void

    • Setter for contentOffsetWidth prop.

      +

      Parameters

      • _: boolean

      Returns void

    draggable

    • get draggable(): any

    • Getter for draggable prop.

      +

      Returns any

    • set draggable(_: any): void

    • Setter for draggable prop.

      +

      Parameters

      • _: any

      Returns void

    draggableOptions

    • get draggableOptions(): any

    • Getter for draggableOptions prop.

      +

      Returns any

    • set draggableOptions(_: any): void

    • Setter for draggableOptions prop.

      +

      Parameters

      • _: any

      Returns void

    elementContent

    • get elementContent(): any

    • Getter for elementContent prop.

      +

      Returns any

    • set elementContent(_: any): void

    • Setter for elementContent prop.

      +

      Parameters

      • _: any

      Returns void

    elementRoot

    • get elementRoot(): any

    • Getter for elementRoot prop.

      +

      Returns any

    • set elementRoot(_: any): void

    • Setter for elementRoot prop.

      +

      Parameters

      • _: any

      Returns void

    inTransition

    • get inTransition(): () => undefined

    • Getter for inTransition prop.

      +

      Returns () => undefined

    • set inTransition(_: () => undefined): void

    • Setter for inTransition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    inTransitionOptions

    outTransition

    • get outTransition(): () => undefined

    • Getter for outTransition prop.

      +

      Returns () => undefined

    • set outTransition(_: () => undefined): void

    • Setter for outTransition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    outTransitionOptions

    stylesApp

    • get stylesApp(): any

    • Getter for stylesApp prop.

      +

      Returns any

    • set stylesApp(_: any): void

    • Setter for stylesApp prop.

      +

      Parameters

      • _: any

      Returns void

    stylesContent

    • get stylesContent(): any

    • Getter for stylesContent prop.

      +

      Returns any

    • set stylesContent(_: any): void

    • Setter for stylesContent prop.

      +

      Parameters

      • _: any

      Returns void

    transition

    • get transition(): () => undefined

    • Getter for transition prop.

      +

      Returns () => undefined

    • set transition(_: () => undefined): void

    • Setter for transition prop.

      +

      Parameters

      • _: () => undefined

      Returns void

    transitionOptions

    • get transitionOptions(): any

    • Getter for transitionOptions prop.

      +

      Returns any

    • set transitionOptions(_: any): void

    • Setter for transitionOptions prop.

      +

      Parameters

      • _: any

      Returns void

    Methods

    $destroy

    $on

    • $on<K extends string>(
          type: K,
          callback: (e: CustomEvent<any>) => void,
      ): () => void

    • Type Parameters

      • K extends string

      Parameters

      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_application.TJSGlassPane.html b/docs/classes/_runtime_svelte_component_application.TJSGlassPane.html index 8fa7935..eb38c9b 100644 --- a/docs/classes/_runtime_svelte_component_application.TJSGlassPane.html +++ b/docs/classes/_runtime_svelte_component_application.TJSGlassPane.html @@ -1,5 +1,5 @@ -TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSGlassPane

    TODO: Add description

    +TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class TJSGlassPane

    TODO: Add description

    @@ -8,10 +8,10 @@
    Hierarchy
    -
    +
    -

    Constructors

    constructor -

    Methods

    $destroy -$on -$set -

    Constructors

    constructor

    Methods

    $destroy

    $on

    $set

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Indexable

    • [prop: string]: any

    Constructors

    constructor +

    Methods

    $destroy +$on +$set +

    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_store_dom_input.KeyStore.html b/docs/classes/_runtime_svelte_store_dom_input.KeyStore.html index 9e56370..9de2e69 100644 --- a/docs/classes/_runtime_svelte_store_dom_input.KeyStore.html +++ b/docs/classes/_runtime_svelte_store_dom_input.KeyStore.html @@ -1,46 +1,46 @@ -KeyStore | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    Class KeyStore

    Provides a readable store to track keys actively pressed. KeyStore is designed to be used with the keyforward action.

    Constructors

    constructor -

    Methods

    _updateSubscribers -addKey -anyPressed -hasKey -isPressed +

    Methods

    _updateSubscribers +addKey +anyPressed +hasKey +isPressed keydown -keysPressed -keysTracked +keysPressed +keysTracked keyup -removeKey -setOptions +removeKey +setOptions subscribe value -

    Constructors

    constructor

    Methods

    Protected_updateSubscribers

    • _updateSubscribers(): void
    • Protected

      Updates subscribers.

      -

      Returns void

    addKey

    • addKey(key): void

    • Add given key to the tracking key set.

      +

    Constructors

    constructor

    Methods

    Protected_updateSubscribers

    • _updateSubscribers(): void
    • Protected

      Updates subscribers.

      +

      Returns void

    addKey

    • addKey(key: string): 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 +

    Returns void

    anyPressed

    • anyPressed(keys?: string | Iterable<string, any, any>): 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

      • Optionalkeys: string | Iterable<string, any, any>

        Zero or more key strings or list to verify if any pressed.

        +

        Parameters

        • Optionalkeys: string | Iterable<string, any, any>

          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.

      +

    hasKey

    • hasKey(key: string): void

    • Is the given key in the tracking key set.

      Parameters

      • key: string

        Key to check.

        -

      Returns void

    isPressed

    • isPressed(keys): boolean

    • Returns true if all given keys are pressed.

      -

      Parameters

      • keys: string | Iterable<string, any, any>

        One or more key strings to verify if pressed.

        +

      Returns void

    isPressed

    • isPressed(keys: string | Iterable<string, any, any>): boolean

    • Returns true if all given keys are pressed.

      +

      Parameters

      • keys: string | Iterable<string, any, any>

        One or more key strings to verify if pressed.

      Returns boolean

      Are all keys pressed.

      -

    keydown

    • keydown(event): void

    • Handle keydown event adding any key from the tracked key set.

      +

    keydown

    • keydown(event: KeyboardEvent): void

    • Handle keydown event adding any key from the tracked key set.

      Parameters

      Returns void

    keysPressed

    keysTracked

    keyup

    • keyup(event): void

    • Handle keyup event removing any key from the tracked key set.

      +

    Returns void

    keysPressed

    keysTracked

    keyup

    • keyup(event: KeyboardEvent): void

    • Handle keyup event removing any key from the tracked key set.

      Parameters

      Returns void

    removeKey

    • removeKey(key): void

    • Remove the given key from the tracking key set.

      +

    Returns void

    removeKey

    • removeKey(key: string): void

    • Remove the given key from the tracking key set.

      Parameters

      • key: string

        Key to remove.

        -

      Returns void

    setOptions

    • setOptions(options): void

    • Update options.

      +

    Returns void

    setOptions

    subscribe

    subscribe

    value

    • value(key): number

    • Parameters

      • key: string

        key or key code to lookup.

        +

    value

    • value(key: string): number

    • Parameters

      • key: string

        key or key code to lookup.

      Returns number

      1 if currently pressed and 0 if not pressed.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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 8b4e0c8..352743f 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocument.html +++ b/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocument.html @@ -1,50 +1,50 @@ -TJSDocument | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSDocument<T>

    Type Parameters

    Constructors

    constructor

    Accessors

    embedded

    updateOptions

    Returns TJSDocument<T>

    Accessors

    embedded

    updateOptions

    uuidv4

    • get uuidv4(): string

    • Returns the UUID assigned to this store.

      +

    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

    • set(document, options?): void

    • Parameters

      • document: T

        New document to set.

        +

        Returns void

    get

    • get(): T

    • Returns T

      Current document

      +

    set

    setFromDataTransfer

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

    • Potentially sets new document from data transfer object.

      +

    Returns void

    setFromDataTransfer

    • setFromDataTransfer(
          data: object,
          options?: { compendium?: boolean; types?: string[]; world?: boolean },
      ): Promise<boolean>

    • Potentially sets new document from data transfer object.

      Parameters

      • data: object

        Document transfer data.

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

      +
    • Optionaloptions: { compendium?: boolean; types?: string[]; world?: boolean }

      Optional parameters for +TJSDocument.getUUIDFromDataTransfer.

      +

    Returns Promise<boolean>

    Returns true if new document set from data transfer blob.

    +

    setFromUUID

    • setFromUUID(uuid: string, options?: TJSDocumentUpdateOptions): 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.

      +

    setOptions

    subscribe

    subscribe

    StaticgetUUIDFromDataTransfer

    • 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: object,
          opts?: { compendium?: boolean; types?: string[]; world?: boolean },
      ): string

    • Attempts to create a Foundry UUID from standard drop data. This may not work for all systems.

      Parameters

      • data: object

        Drop transfer data.

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

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

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 b98b3cf..b189377 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocumentCollection.html +++ b/docs/classes/_runtime_svelte_store_fvtt_document.TJSDocumentCollection.html @@ -1,29 +1,29 @@ -TJSDocumentCollection | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 -

    Accessors

    updateOptions +

    Type Parameters

    Constructors

    constructor +

    Accessors

    updateOptions uuid

    Methods

    destroy get set -setOptions +setOptions subscribe -

    Constructors

    constructor

    Constructors

    constructor

    Accessors

    updateOptions

    uuid

    • get uuid(): string

    • Returns the UUID assigned to this store.

      +

    Returns TJSDocumentCollection<T>

    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

      Returns void

    setOptions

    • setOptions(options): void

    • Sets options for this collection wrapper / store.

      +

      Returns void

    get

    • get(): T

    • Returns T

      Current collection

      +

    set

    setOptions

    subscribe

    subscribe

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 97a57df..8fd35ad 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_settings.TJSGameSettings.html +++ b/docs/classes/_runtime_svelte_store_fvtt_settings.TJSGameSettings.html @@ -1,5 +1,5 @@ -TJSGameSettings | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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.

    @@ -13,41 +13,41 @@
    Hierarchy
    -
    +

    Constructors

    constructor

    Accessors

    namespace

    Methods

    data entries -getReadableStore -getStore -getWritableStore +getReadableStore +getStore +getWritableStore keys register -registerAll +registerAll stores -

    Constructors

    constructor

    • new TJSGameSettings(namespace): TJSGameSettings

    • Creates the TJSGameSettings instance.

      +

    Constructors

    constructor

    • new TJSGameSettings(namespace: string): 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.

      -

    Methods

    data

    Returns TJSGameSettings

    Accessors

    namespace

    • get namespace(): string

    • Returns string

      Returns namespace set in constructor.

      +

    Methods

    data

    entries

    • entries<T>(regex?): IterableIterator<[string, Writable<T>], any, any>

    • Type Parameters

      • T

        Returns an iterable for the game setting keys and stores.

        +

    Returns IterableIterator<GameSettingOptions, any, any>

    Iterable iterator of GameSettingData.

    +

    Yields

    entries

    • entries<T>(regex?: RegExp): IterableIterator<[string, Writable<T>], any, any>

    • 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>], any, any>

      Iterable iterator of keys and stores.

      -

      Yields

    getReadableStore

    • getReadableStore(key): Readable<any>

    • Returns a readable Game Settings store for the associated key.

      +

    Returns IterableIterator<[string, Writable<T>], any, any>

    Iterable iterator of keys and stores.

    +

    Yields

    getReadableStore

    • getReadableStore(key: string): 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.

      +

    getStore

    • getStore(key: string): Writable<any>

    • Returns a writable Game Settings store for the associated key.

      Parameters

      • key: string

        Game setting key.

      Returns Writable<any>

      The associated store for the given game setting key.

      -

    getWritableStore

    • getWritableStore(key): Writable<any>

    • Returns a writable Game Settings store for the associated key.

      +

    getWritableStore

    • getWritableStore(key: string): Writable<any>

    • Returns a writable Game Settings store for the associated key.

      Parameters

      • key: string

        Game setting key.

      Returns Writable<any>

      The associated store for the given game setting key.

      -

    keys

    • keys(regex?): IterableIterator<string, any, any>

    • Returns an iterable for the game setting keys from existing stores.

      +

    keys

    • keys(regex?: RegExp): IterableIterator<string, any, any>

    • Returns an iterable for the game setting keys from existing stores.

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by game setting keys.

        -

      Returns IterableIterator<string, any, any>

      Iterable iterator of game setting keys.

      -

      Yields

    register

    • register(setting, coreConfig?): Function

    • Registers a setting with TJSGameSettings and Foundry core.

      +

    Returns IterableIterator<string, any, any>

    Iterable iterator of game setting keys.

    +

    Yields

    register

    • register(setting: GameSetting, coreConfig?: boolean): 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 @@ -59,16 +59,16 @@

      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.

      +

    registerAll

    • registerAll(
          settings: Iterable<GameSetting, any, any>,
          coreConfig: boolean,
      ): { [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, any, any>

        An iterable list of game setting configurations to register.

        +

        Parameters

        • settings: Iterable<GameSetting, any, any>

          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.

          -

        Returns {
            [key: string]: Function;
        }

        An object containing all TJSGameSetting store subscriber handlers for each +

    Returns { [key: string]: Function }

    An object containing all TJSGameSetting store subscriber handlers for each setting key added.

    -

    stores

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns IterableIterator<Writable<T>, any, any>

    Iterable iterator of stores.

    +

    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 926719b..03a09af 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_settings.TJSLiveGameSettings.html +++ b/docs/classes/_runtime_svelte_store_fvtt_settings.TJSLiveGameSettings.html @@ -1,5 +1,5 @@ -TJSLiveGameSettings | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 @@ -10,33 +10,33 @@

    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 -

    Accessors

    lastKey +

    Accessors

    lastKey

    Methods

    _update destroy entries keys subscribe -toString +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: TJSGameSettings,
          options?: { exclude?: Set<string>; include?: Set<string> },
      ): 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...

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

      +
    • 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: string): 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], any, any>

    • Returns an iterator / generator of all setting entries.

      -

      Returns IterableIterator<[key: string, value: any], any, any>

      An iterator returning setting entries.

      -

      Yields

    keys

    • keys(): IterableIterator<string, any, any>

    • Returns an iterator / generator of all setting keys.

      -

      Returns IterableIterator<string, any, any>

      An iterator returning setting keys.

      -

      Yields

    subscribe

    destroy

    • destroy(): void

    • Destroys this instance of TJSLiveGameSettings and unsubscribes from all game setting stores.

      +

      Returns void

    entries

    • entries(): IterableIterator<[key: string, value: any], any, any>

    • Returns an iterator / generator of all setting entries.

      +

      Returns IterableIterator<[key: string, value: any], any, any>

      An iterator returning setting entries.

      +

      Yields

    keys

    • keys(): IterableIterator<string, any, any>

    • Returns an iterator / generator of all setting keys.

      +

      Returns IterableIterator<string, any, any>

      An iterator returning setting keys.

      +

      Yields

    subscribe

    toString

    • toString(): string

    • Returns a string / JSON stringify of the current setting data.

      +

    Returns Unsubscriber

    Unsubscribe function.

    +

    toString

    • toString(): string

    • Returns a string / JSON stringify of the current setting data.

      Returns string

      Tracked setting data.

      -

    values

    • values(): IterableIterator<any, any, any>

    • Returns an iterator / generator of all values.

      -

      Returns IterableIterator<any, any, any>

      An iterator returning setting values.

      -

      Yields

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    values

    • values(): IterableIterator<any, any, any>

    • Returns an iterator / generator of all values.

      +

      Returns IterableIterator<any, any, any>

      An iterator returning setting values.

      +

      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_world.WorldSettingArrayStore.html b/docs/classes/_runtime_svelte_store_fvtt_settings_world.WorldSettingArrayStore.html index 22f0972..ff502f1 100644 --- a/docs/classes/_runtime_svelte_store_fvtt_settings_world.WorldSettingArrayStore.html +++ b/docs/classes/_runtime_svelte_store_fvtt_settings_world.WorldSettingArrayStore.html @@ -1,5 +1,5 @@ -WorldSettingArrayStore | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class WorldSettingArrayStore<T>

    Type Parameters

    +WorldSettingArrayStore | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class WorldSettingArrayStore<T>

    Type Parameters

    @@ -7,58 +7,58 @@
    Hierarchy
    -
    +

    Constructors

    constructor

    Accessors

    _data -dataReducer +dataReducer key length namespace -EntryStore -

    Methods

    [iterator] -clearEntries -createEntry -deleteEntry -duplicateEntry -findEntry -getEntry +EntryStore +

    Methods

    [iterator] +clearEntries +createEntry +deleteEntry +duplicateEntry +findEntry +getEntry set subscribe -toJSON -updateSubscribers -

    Constructors

    constructor

    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.

      -

    StaticEntryStore

    Methods

    [iterator]

    clearEntries

    createEntry

    • createEntry(entryData?): T

    • Creates a new store from given data.

      -

      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.

      +

    Returns WorldSettingArrayStore<T>

    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.

      +

    StaticEntryStore

    Methods

    [iterator]

    clearEntries

    createEntry

    • createEntry(entryData?: object): T

    • Creates a new store from given data.

      +

      Parameters

      • OptionalentryData: object

      Returns T

      The store

      +

    deleteEntry

    • deleteEntry(id: string): 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.

      -

    duplicateEntry

    duplicateEntry

    • duplicateEntry(id: string): any

    • Duplicates an entry store by the given ID.

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

    findEntry

    • findEntry(predicate: (arg0: T) => void | T): void | T

    • Find an entry in the backing child store array.

      +

      Parameters

      • predicate: (arg0: T) => void | T

        A predicate function

        +

      Returns void | T

      Found entry in array or undefined.

      +

    getEntry

    • getEntry(id: string): void | T

    • Finds an entry store instance by 'id' / UUIDv4.

      Parameters

      • id: string

        A UUIDv4 string.

        -

      Returns void | T

      Entry store instance.

      -

    set

    • set(updateList): void

    • Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the +

    Returns void | T

    Entry store instance.

    +

    set

    • set(updateList: T[]): void

    • Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the update list.

      -

      Parameters

      • updateList: T[]

      Returns void

    subscribe

    subscribe

    toJSON

    updateSubscribers

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    toJSON

    updateSubscribers

    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 564d21f..fa2f2fb 100644 --- a/docs/classes/_runtime_svelte_store_position.TJSPosition.html +++ b/docs/classes/_runtime_svelte_store_position.TJSPosition.html @@ -1,5 +1,5 @@ -TJSPosition | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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.

    @@ -16,112 +16,112 @@

    Accessors

    animate dimension element -elementUpdated +elementUpdated enabled height left -maxHeight -maxWidth -minHeight -minWidth +maxHeight +maxWidth +minHeight +minWidth parent -rotateX -rotateY -rotateZ +rotateX +rotateY +rotateZ rotation scale state stores top transform -transformOrigin -translateX -translateY -translateZ +transformOrigin +translateX +translateY +translateZ validators width -zIndex -Animate -Data -Initial -SystemBase -TransformData -transformOrigins -Validators +zIndex +Animate +Data +Initial +SystemBase +TransformData +transformOrigins +Validators

    Methods

    get set subscribe -toJSON +toJSON update -copyData +copyData duplicate -

    Constructors

    constructor

    Constructors

    constructor

    Accessors

    animate

    Returns TJSPosition

    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.

      -

    element

    • get element(): HTMLElement

    • Returns the current HTMLElement being positioned.

      +

    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.

      +

    element

    • get element(): HTMLElement

    • Returns the current HTMLElement being positioned.

      Returns HTMLElement

      Current HTMLElement being positioned.

      -

    elementUpdated

    • get elementUpdated(): Promise<number>

    • Returns a promise that is resolved on the next element update with the time of the update.

      +

    elementUpdated

    • get elementUpdated(): Promise<number>

    • Returns a promise that is resolved on the next element update with the time of the update.

      Returns Promise<number>

      Promise resolved on element update.

      -

    enabled

    • get enabled(): boolean

    • Returns the enabled state.

      +

    enabled

    • get enabled(): boolean

    • Returns the enabled state.

      Returns boolean

      Enabled state.

      -
    • set enabled(enabled): void

    • Sets the enabled state.

      +
    • set enabled(enabled: boolean): void

    • Sets the enabled state.

      Parameters

      • enabled: boolean

        New enabled state.

        -

      Returns void

    height

    • get height(): number | "auto" | "inherit"

    • Returns number | "auto" | "inherit"

      height

      -
    • set height(height): void

    • Parameters

      • height: number | "auto" | "inherit"

      Returns void

    left

    • get left(): number

    • Returns number

      left

      -
    • set left(left): void

    • Parameters

      • left: string | number

      Returns void

    maxHeight

    • get maxHeight(): number

    • Returns number

      maxHeight

      -
    • set maxHeight(maxHeight): void

    • Parameters

      • maxHeight: string | number

      Returns void

    maxWidth

    • get maxWidth(): number

    • Returns number

      maxWidth

      -
    • set maxWidth(maxWidth): void

    • Parameters

      • maxWidth: string | number

      Returns void

    minHeight

    • get minHeight(): number

    • Returns number

      minHeight

      -
    • set minHeight(minHeight): void

    • Parameters

      • minHeight: string | number

      Returns void

    minWidth

    • get minWidth(): number

    • Returns number

      minWidth

      -
    • set minWidth(minWidth): void

    • Parameters

      • minWidth: string | number

      Returns void

    parent

    Returns void

    height

    • get height(): number | "auto" | "inherit"

    • Returns number | "auto" | "inherit"

      height

      +
    • set height(height: number | "auto" | "inherit"): void

    • Parameters

      • height: number | "auto" | "inherit"

      Returns void

    left

    • get left(): number

    • Returns number

      left

      +
    • set left(left: string | number): void

    • Parameters

      • left: string | number

      Returns void

    maxHeight

    • get maxHeight(): number

    • Returns number

      maxHeight

      +
    • set maxHeight(maxHeight: string | number): void

    • Parameters

      • maxHeight: string | number

      Returns void

    maxWidth

    • get maxWidth(): number

    • Returns number

      maxWidth

      +
    • set maxWidth(maxWidth: string | number): void

    • Parameters

      • maxWidth: string | number

      Returns void

    minHeight

    • get minHeight(): number

    • Returns number

      minHeight

      +
    • set minHeight(minHeight: string | number): void

    • Parameters

      • minHeight: string | number

      Returns void

    minWidth

    • get minWidth(): number

    • Returns number

      minWidth

      +
    • set minWidth(minWidth: string | number): void

    • Parameters

      • minWidth: string | number

      Returns void

    parent

    rotateX

    • get rotateX(): number

    • Returns number

      rotateX

      -
    • set rotateX(rotateX): void

    • Parameters

      • rotateX: string | number

      Returns void

    rotateY

    • get rotateY(): number

    • Returns number

      rotateY

      -
    • set rotateY(rotateY): void

    • Parameters

      • rotateY: string | number

      Returns void

    rotateZ

    • get rotateZ(): number

    • Returns number

      rotateZ

      -
    • set rotateZ(rotateZ): void

    • Parameters

      • rotateZ: string | number

      Returns void

    rotation

    • get rotation(): number

    • Returns number

      alias for rotateZ

      -
    • set rotation(rotateZ): void

    • Parameters

      • rotateZ: string | number

        alias for rotateZ

        -

      Returns void

    scale

    • get scale(): number

    • Returns number

      scale

      -
    • set scale(scale): void

    • Parameters

      • scale: string | number

      Returns void

    state

    Returns void

    rotateX

    • get rotateX(): number

    • Returns number

      rotateX

      +
    • set rotateX(rotateX: string | number): void

    • Parameters

      • rotateX: string | number

      Returns void

    rotateY

    • get rotateY(): number

    • Returns number

      rotateY

      +
    • set rotateY(rotateY: string | number): void

    • Parameters

      • rotateY: string | number

      Returns void

    rotateZ

    • get rotateZ(): number

    • Returns number

      rotateZ

      +
    • set rotateZ(rotateZ: string | number): void

    • Parameters

      • rotateZ: string | number

      Returns void

    rotation

    • get rotation(): number

    • Returns number

      alias for rotateZ

      +
    • set rotation(rotateZ: string | number): void

    • Parameters

      • rotateZ: string | number

        alias for rotateZ

        +

      Returns void

    scale

    • get scale(): number

    • Returns number

      scale

      +
    • set scale(scale: string | number): void

    • Parameters

      • scale: string | number

      Returns void

    state

    stores

    stores

    top

    • get top(): number

    • Returns number

      top

      -
    • set top(top): void

    • Parameters

      • top: string | number

      Returns void

    transform

    transformOrigin

    translateX

    • get translateX(): number

    • Returns number

      translateX

      -
    • set translateX(translateX): void

    • Parameters

      • translateX: string | number

      Returns void

    translateY

    • get translateY(): number

    • Returns number

      translateY

      -
    • set translateY(translateY): void

    • Parameters

      • translateY: string | number

      Returns void

    translateZ

    • get translateZ(): number

    • Returns number

      translateZ

      -
    • set translateZ(translateZ): void

    • Parameters

      • translateZ: string | number

      Returns void

    validators

    top

    • get top(): number

    • Returns number

      top

      +
    • set top(top: string | number): void

    • Parameters

      • top: string | number

      Returns void

    transform

    transformOrigin

    translateX

    • get translateX(): number

    • Returns number

      translateX

      +
    • set translateX(translateX: string | number): void

    • Parameters

      • translateX: string | number

      Returns void

    translateY

    • get translateY(): number

    • Returns number

      translateY

      +
    • set translateY(translateY: string | number): void

    • Parameters

      • translateY: string | number

      Returns void

    translateZ

    • get translateZ(): number

    • Returns number

      translateZ

      +
    • set translateZ(translateZ: string | number): void

    • Parameters

      • translateZ: string | number

      Returns void

    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: string | number

      Returns void

    StaticAnimate

    StaticData

    StaticInitial

    StaticSystemBase

    StaticTransformData

    width

    • get width(): number | "auto" | "inherit"

    • Returns number | "auto" | "inherit"

      width

      +
    • set width(width: number | "auto" | "inherit"): void

    • Parameters

      • width: number | "auto" | "inherit"

      Returns void

    zIndex

    • get zIndex(): number

    • Returns number

      z-index

      +
    • set zIndex(zIndex: string | number): void

    • Parameters

      • zIndex: string | number

      Returns void

    StaticAnimate

    StaticData

    StaticInitial

    StaticSystemBase

    StaticTransformData

    StatictransformOrigins

    • get transformOrigins(): readonly TransformOrigin[]

    • Returns a list of supported transform origins.

      -

      Returns readonly TransformOrigin[]

      The supported transform origin +

    StatictransformOrigins

    • get transformOrigins(): readonly TransformOrigin[]

    • Returns a list of supported transform origins.

      +

      Returns readonly TransformOrigin[]

      The supported transform origin strings.

      -

    StaticValidators

    StaticValidators

    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?: object, options?: OptionsGet): 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

      • 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

    • set(position?, options?): TJSPosition

    • All calculation and updates of position are implemented in TJSPosition. This allows position to be fully +

    set

    • set(position?: TJSPositionDataRelative, options?: OptionsSet): TJSPosition

    • All calculation and updates of position are implemented in TJSPosition. This allows position to be fully reactive and in control of updating inline styles for a connected HTMLElement.

      The initial set call with a target element will always set width / height as this is necessary for correct calculations.

      @@ -130,7 +130,7 @@
      TJSPosition.validators.

      Updates to any target element are decoupled from the underlying TJSPosition data. This method returns this instance that you can then await on the target element inline style update by using -TJSPosition.elementUpdated.

      +TJSPosition.elementUpdated.

      Relative updates to any property of TJSPositionData are possible by specifying properties as strings. This string should be in the form of '+=', '-=', or '*=' and float / numeric value. IE '+=0.2'. TJSPosition.set will apply the addition, subtraction, or multiplication operation specified against @@ -139,21 +139,21 @@

      Parameters

      Returns TJSPosition

      This TJSPosition instance.

      -

    subscribe

    subscribe

    toJSON

    update

    toJSON

    update

    StaticcopyData

    StaticcopyData

    • copyData(
          source: Partial<TJSPositionData>,
          target?: TJSPositionData,
      ): 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

      Returns TJSPositionData

      The target instance with all TJSPositionData fields.

      -

    Staticduplicate

    • 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

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 cb79def..cc47f58 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynArrayReducer.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducer.html @@ -1,7 +1,7 @@ -DynArrayReducer | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class DynArrayReducer<T>

    Provides a managed array with non-destructive reducing / filtering / sorting capabilities with subscription / +DynArrayReducer | TyphonJS Runtime Library (FVTT) 0.2.0

    +

    Class DynArrayReducer<T>

    Provides a managed array with non-destructive reducing / filtering / sorting capabilities with subscription / Svelte store support.

    -

    Type Parameters

    • T
    +

    Type Parameters

    • T
    @@ -9,7 +9,7 @@
    Hierarchy
    -
    +

    Constructors

    constructor

    Accessors

    data @@ -20,41 +20,41 @@
    length reversed sort -

    Methods

    [iterator] +

    Methods

    [iterator] destroy initialize -setData +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?: Iterable<T, any, any> | DynArrayData<T>,
      ): 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.

      -

      Returns T[]

      The internal data.

      -

    derived

    destroyed

    • get destroyed(): boolean

    • Returns boolean

      Returns whether this instance is destroyed.

      -

    filters

    index

    length

    • get length(): number

    • Gets the main data / items length.

      +

      Returns T[]

      The internal data.

      +

    derived

    destroyed

    • get destroyed(): boolean

    • Returns boolean

      Returns whether this instance is destroyed.

      +

    filters

    index

    length

    • get length(): number

    • Gets the main data / items length.

      Returns number

      Main data / items length.

      -

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      +

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      Returns boolean

      Reversed state.

      -
    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      +
    • set reversed(reversed: boolean): void

    • Sets reversed state and notifies subscribers.

      Parameters

      • reversed: boolean

        New reversed state.

        -

      Returns void

    sort

    Methods

    [iterator]

    • [iterator](): IterableIterator<T, any, any>

    • Provides an iterator for data stored in DynArrayReducer.

      -

      Returns IterableIterator<T, any, any>

      Iterator for data stored in DynArrayReducer.

      -

      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 +

    Returns void

    sort

    Methods

    [iterator]

    • "[iterator]"(): IterableIterator<T, any, any>

    • Provides an iterator for data stored in DynArrayReducer.

      +

      Returns IterableIterator<T, any, any>

      Iterator for data stored in DynArrayReducer.

      +

      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 +

      Returns void

    setData

    • setData(data: Iterable<T, any, any> | T[], replace?: boolean): 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, any, any> | T[]

        New data to set to internal data.

        +

        Parameters

        • data: Iterable<T, any, any> | T[]

          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: DynArrayReducer<T>) => void)

        Callback function that is invoked on update / changes. +

      Returns void

    subscribe

    • subscribe(handler: (value: DynArrayReducer<T>) => void): () => void

    • Add a subscriber to this DynArrayReducer instance.

      +

      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

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns () => void

    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_reducer.DynArrayReducerDerived.html b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html index 7b8926b..ad79c2f 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynArrayReducerDerived.html @@ -1,8 +1,8 @@ -DynArrayReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class DynArrayReducerDerived<T>

    Provides the base implementation derived reducer for arrays / DynArrayReducer.

    +DynArrayReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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
    +

    Type Parameters

    • T
    @@ -10,7 +10,7 @@
    -
    +

    Constructors

    constructor

    Accessors

    data @@ -21,34 +21,34 @@
    length reversed sort -

    Methods

    [iterator] +

    Methods

    [iterator] destroy initialize 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 DynIndexerAPI.update with true to recalculate the index and notify all subscribers.

      -

      Returns T[]

      The internal data.

      -

    derived

    destroyed

    • get destroyed(): boolean

    • Returns whether this derived reducer is destroyed.

      -

      Returns boolean

    filters

    index

    • get index(): DynIndexerAPI<number, T>

    • Returns the Indexer public API.

      -

      Returns DynIndexerAPI<number, T>

      Indexer API - is also iterable.

      -

    length

    • get length(): number

    • Returns number

      Main data / items length or indexed length.

      -

    reversed

    • get reversed(): boolean

    • Returns boolean

      Gets current reversed state.

      -
    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      +

      Returns T[]

      The internal data.

      +

    derived

    destroyed

    • get destroyed(): boolean

    • Returns whether this derived reducer is destroyed.

      +

      Returns boolean

    filters

    index

    • get index(): DynIndexerAPI<number, T>

    • Returns the Indexer public API.

      +

      Returns DynIndexerAPI<number, T>

      Indexer API - is also iterable.

      +

    length

    • get length(): number

    • Returns number

      Main data / items length or indexed length.

      +

    reversed

    • get reversed(): boolean

    • Returns boolean

      Gets current reversed state.

      +
    • set reversed(reversed: boolean): 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

    Protectedinitialize

    • initialize(optionsRest?): void
    • Protected

      Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows +

    Returns void

    sort

    Methods

    [iterator]

    destroy

    • destroy(): void

    • Removes all derived reducers, subscriptions, and cleans up all resources.

      +

      Returns void

    Protectedinitialize

    • initialize(optionsRest?: { [key: string]: any }): void
    • Protected

      Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

      -

      Parameters

      • OptionaloptionsRest: {
            [key: string]: any;
        }

        Any additional custom options passed beyond DynDataOptions.

        -
        • [key: string]: any

      Returns void

    subscribe

    • subscribe(handler): (() => void)

    • Subscribe to this DerivedArrayReducer.

      -

      Parameters

      Returns (() => void)

      Unsubscribe function.

      -
        • (): void

        • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Parameters

    • OptionaloptionsRest: { [key: string]: any }

      Any additional custom options passed beyond DynDataOptions.

      +

    Returns void

    subscribe

    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 ac39a2e..9ec6cfb 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynMapReducer.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynMapReducer.html @@ -1,8 +1,8 @@ -DynMapReducer | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 @@ -11,40 +11,40 @@ length reversed sort -

    Methods

    [iterator] +

    Methods

    [iterator] destroy initialize -setData +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?: Map<K, T> | DynMapData<K, T>,
      ): 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

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

      +

      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.

      -

      Returns Map<K, T>

      The internal data.

      -

    derived

    destroyed

    • get destroyed(): boolean

    • Returns boolean

      Returns whether this instance is destroyed.

      -

    filters

    index

    length

    • get length(): number

    • Gets the main data / items length.

      +

      Returns Map<K, T>

      The internal data.

      +

    derived

    destroyed

    • get destroyed(): boolean

    • Returns boolean

      Returns whether this instance is destroyed.

      +

    filters

    index

    length

    • get length(): number

    • Gets the main data / items length.

      Returns number

      Main data / items length.

      -

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      +

    reversed

    • get reversed(): boolean

    • Gets current reversed state.

      Returns boolean

      Reversed state.

      -
    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      +
    • set reversed(reversed: boolean): 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

    Protectedinitialize

    • initialize(): void
    • Protected

      Provides a callback for custom reducers to initialize any data / custom configuration. This allows +

    Returns void

    sort

    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 +

      Returns void

    setData

    • setData(data: Map<K, T>, replace?: boolean): 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.

        +

        Parameters

        • data: Map<K, T>

          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: DynMapReducer<K, T>) => void)

        Callback function that is invoked on update / changes. +

      Returns void

    subscribe

    • subscribe(handler: (value: DynMapReducer<K, T>) => void): () => void

    • Add a subscriber to this DynMapReducer instance.

      +

      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

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Returns () => void

    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_reducer.DynMapReducerDerived.html b/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html index a004701..bcff1a3 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynMapReducerDerived.html @@ -1,9 +1,9 @@ -DynMapReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class DynMapReducerDerived<K, T>

    Provides the base implementation derived reducer for Maps / DynMapReducer.

    +DynMapReducerDerived | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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
    +

    Template: K,

    T

    +

    Type Parameters

    • K
    • T
    @@ -11,7 +11,7 @@
    -
    +

    Constructors

    constructor

    Accessors

    data @@ -22,34 +22,34 @@
    length reversed sort -

    Methods

    [iterator] +

    Methods

    [iterator] destroy initialize subscribe -

    Constructors

    constructor

    Accessors

    data

    • get data(): Map<K, T>

    • Returns the internal data of this instance. Be careful!

      +

    Constructors

    constructor

    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 DynIndexerAPI.update with true to recalculate the index and notify all subscribers.

      -

      Returns Map<K, T>

      The internal data.

      -

    derived

    destroyed

    • get destroyed(): boolean

    • Returns whether this derived reducer is destroyed.

      -

      Returns boolean

    filters

    index

    • get index(): DynIndexerAPI<K, T>

    • Returns the Indexer public API.

      -

      Returns DynIndexerAPI<K, T>

      Indexer API - is also iterable.

      -

    length

    • get length(): number

    • Returns number

      Main data / items length or indexed length.

      -

    reversed

    • get reversed(): boolean

    • Returns boolean

      Gets current reversed state.

      -
    • set reversed(reversed): void

    • Sets reversed state and notifies subscribers.

      +

      Returns Map<K, T>

      The internal data.

      +

    derived

    destroyed

    • get destroyed(): boolean

    • Returns whether this derived reducer is destroyed.

      +

      Returns boolean

    filters

    index

    • get index(): DynIndexerAPI<K, T>

    • Returns the Indexer public API.

      +

      Returns DynIndexerAPI<K, T>

      Indexer API - is also iterable.

      +

    length

    • get length(): number

    • Returns number

      Main data / items length or indexed length.

      +

    reversed

    • get reversed(): boolean

    • Returns boolean

      Gets current reversed state.

      +
    • set reversed(reversed: boolean): 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

    Protectedinitialize

    • initialize(optionsRest?): void
    • Protected

      Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows +

    Returns void

    sort

    Methods

    [iterator]

    destroy

    • destroy(): void

    • Removes all derived reducers, subscriptions, and cleans up all resources.

      +

      Returns void

    Protectedinitialize

    • initialize(optionsRest?: { [key: string]: any }): void
    • Protected

      Provides a callback for custom derived reducers to initialize any data / custom configuration. This allows child classes to avoid implementing the constructor.

      -

      Parameters

      • OptionaloptionsRest: {
            [key: string]: any;
        }

        Any additional custom options passed beyond DynDataOptions.

        -
        • [key: string]: any

      Returns void

    subscribe

    • subscribe(handler): (() => void)

    • Subscribe to this DerivedMapReducer.

      -

      Parameters

      Returns (() => void)

      Unsubscribe function.

      -
        • (): void

        • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ No newline at end of file +

    Parameters

    • OptionaloptionsRest: { [key: string]: any }

      Any additional custom options passed beyond DynDataOptions.

      +

    Returns void

    subscribe

    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 b85d6c6..4dcee12 100644 --- a/docs/classes/_runtime_svelte_store_reducer.DynReducerHelper.html +++ b/docs/classes/_runtime_svelte_store_reducer.DynReducerHelper.html @@ -1,14 +1,14 @@ -DynReducerHelper | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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

    Accessors

    filters -

    Constructors

    constructor

    Accessors

    Staticfilters

    • get filters(): {
          regexObjectQuery: ((accessors: string | Iterable<string, any, any>, options?: {
              accessWarn?: boolean;
              caseSensitive?: boolean;
              store?: Writable<string>;
          }) => ((data: {}) => boolean) & MinimalWritable<string>);
      }

    • Returns the following filter functions:

      +

    Constructors

    constructor

    Accessors

    Staticfilters

    • get filters(): {
          regexObjectQuery: (
              accessors: string | Iterable<string, any, any>,
              options?: {
                  accessWarn?: boolean;
                  caseSensitive?: boolean;
                  store?: Writable<string>;
              },
          ) => (data: {}) => boolean & MinimalWritable<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: string | Iterable<string, any, any>, options?: {
              accessWarn?: boolean;
              caseSensitive?: boolean;
              store?: Writable<string>;
          }) => ((data: {}) => boolean) & MinimalWritable<string>);
      }

      All available filters.

      -
      • regexObjectQuery: ((accessors: string | Iterable<string, any, any>, options?: {
            accessWarn?: boolean;
            caseSensitive?: boolean;
            store?: Writable<string>;
        }) => ((data: {}) => boolean) & MinimalWritable<string>)
          • (accessors, options?): ((data: {}) => boolean) & MinimalWritable<string>

          • Parameters

            • accessors: string | Iterable<string, any, any>
            • Optionaloptions: {
                  accessWarn?: boolean;
                  caseSensitive?: boolean;
                  store?: Writable<string>;
              }
              • OptionalaccessWarn?: boolean
              • OptionalcaseSensitive?: boolean
              • Optionalstore?: Writable<string>

            Returns ((data: {}) => boolean) & MinimalWritable<string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    \ No newline at end of file +

    Returns {
        regexObjectQuery: (
            accessors: string | Iterable<string, any, any>,
            options?: {
                accessWarn?: boolean;
                caseSensitive?: boolean;
                store?: Writable<string>;
            },
        ) => (data: {}) => boolean & MinimalWritable<string>;
    }

    All available filters.

    +

    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 deleted file mode 100644 index 1253ffd..0000000 --- a/docs/classes/_runtime_svelte_store_reducer_array_object.ArrayObjectStore.html +++ /dev/null @@ -1,53 +0,0 @@ -ArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class ArrayObjectStore<T>

    Type Parameters

    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Accessors

    _data -dataReducer -length -EntryStore -

    Methods

    [iterator] -clearEntries -createEntry -deleteEntry -duplicateEntry -findEntry -getEntry -set -subscribe -toJSON -updateSubscribers -

    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.

      -

    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

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

      -

    duplicateEntry

    • duplicateEntry(id): any

    • Duplicates an entry store by the given ID.

      -

      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: 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.

        -

      Returns void | T

      Entry store instance.

      -

    set

    • set(updateList): void

    • Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the -update list.

      -

      Parameters

      • updateList: T[]

      Returns void

    subscribe

    toJSON

    • toJSON(): T[]

    • Returns T[]

    updateSubscribers

    • updateSubscribers(update?): void

    • Updates subscribers.

      -

      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 deleted file mode 100644 index 0938a19..0000000 --- a/docs/classes/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStore.html +++ /dev/null @@ -1,55 +0,0 @@ -CrudArrayObjectStore | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class CrudArrayObjectStore<T>

    Type Parameters

    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Accessors

    _data -dataReducer -length -EntryStore -

    Methods

    [iterator] -clearEntries -createEntry -deleteEntry -duplicateEntry -findEntry -getEntry -set -subscribe -toJSON -updateSubscribers -

    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.

      -

    StaticEntryStore

    Methods

    [iterator]

    clearEntries

    createEntry

    • createEntry(entryData?): T

    • Creates a new store from given data.

      -

      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.

      -

    duplicateEntry

    • duplicateEntry(id): any

    • Duplicates an entry store by the given ID.

      -

      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: 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.

        -

      Returns void | T

      Entry store instance.

      -

    set

    • set(updateList): void

    • Sets the children store data by 'id', adds new entry store instances, or removes entries that are no longer in the -update list.

      -

      Parameters

      • updateList: T[]

      Returns void

    subscribe

    toJSON

    updateSubscribers

    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 deleted file mode 100644 index b5adfa2..0000000 --- a/docs/classes/_runtime_svelte_store_reducer_array_object.ObjectEntryStore.html +++ /dev/null @@ -1,19 +0,0 @@ -ObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class ObjectEntryStore

    Provides a base implementation for store entries in ArrayObjectStore.

    -

    In particular providing the required getting / accessor for the 'id' property.

    -

    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.

      -

    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

    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

    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 deleted file mode 100644 index 84470b9..0000000 --- a/docs/classes/_runtime_svelte_store_web_storage.TJSLocalStorage.html +++ /dev/null @@ -1,50 +0,0 @@ -TJSLocalStorage | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSLocalStorage

    Provides a TJSWebStorage instance for standard browser local storage use cases.

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Methods

    entries -getItem -getStore -hasStore -keys -setItem -stores -swapItemBoolean -

    Constructors

    constructor

    Methods

    entries

    getItem

    • getItem(key, defaultValue?): any

    • Get value from the storage API.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

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

      -

    hasStore

    • hasStore(key): boolean

    • Returns whether a store has already been created for the given key.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

        -

      Returns boolean

    keys

    • keys(regex?): IterableIterator<string, any, any>

    • Returns an iterable for the session storage keys from existing stores.

      -

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by storage keys.

        -

      Returns IterableIterator<string, any, any>

      Iterable iterator of session storage keys.

      -

      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

    swapItemBoolean

    • swapItemBoolean(key, defaultValue?): boolean

    • Convenience method to swap a boolean value stored in storage API updating the associated store value.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

    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 deleted file mode 100644 index 47be876..0000000 --- a/docs/classes/_runtime_svelte_store_web_storage.TJSSessionStorage.html +++ /dev/null @@ -1,50 +0,0 @@ -TJSSessionStorage | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSSessionStorage

    Provides a TJSWebStorage instance for standard browser session storage use cases.

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Methods

    entries -getItem -getStore -hasStore -keys -setItem -stores -swapItemBoolean -

    Constructors

    constructor

    Methods

    entries

    getItem

    • getItem(key, defaultValue?): any

    • Get value from the storage API.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

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

      -

    hasStore

    • hasStore(key): boolean

    • Returns whether a store has already been created for the given key.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

        -

      Returns boolean

    keys

    • keys(regex?): IterableIterator<string, any, any>

    • Returns an iterable for the session storage keys from existing stores.

      -

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by storage keys.

        -

      Returns IterableIterator<string, any, any>

      Iterable iterator of session storage keys.

      -

      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

    swapItemBoolean

    • swapItemBoolean(key, defaultValue?): boolean

    • Convenience method to swap a boolean value stored in storage API updating the associated store value.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

    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 deleted file mode 100644 index 81bf508..0000000 --- a/docs/classes/_runtime_svelte_store_web_storage.TJSWebStorage.html +++ /dev/null @@ -1,65 +0,0 @@ -TJSWebStorage | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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.

    -
    -
    - -
    - Implements -
    -     -
    -
    -
    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Methods

    entries -getItem -getStore -hasStore -keys -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

    • entries<T>(regex?): IterableIterator<[string, Writable<T>], any, any>

    • Type Parameters

      • T

        Returns an iterable for the session storage keys and stores.

        -

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by storage keys.

        -

      Returns IterableIterator<[string, Writable<T>], any, any>

      Iterable iterator of keys and stores.

      -

      Yields

    getItem

    • getItem(key, defaultValue?): any

    • Get value from the storage API.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

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

      -

    hasStore

    • hasStore(key): boolean

    • Returns whether a store has already been created for the given key.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

        -

      Returns boolean

    keys

    • keys(regex?): IterableIterator<string, any, any>

    • Returns an iterable for the session storage keys from existing stores.

      -

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by storage keys.

        -

      Returns IterableIterator<string, any, any>

      Iterable iterator of session storage keys.

      -

      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

    swapItemBoolean

    • swapItemBoolean(key, defaultValue?): boolean

    • Convenience method to swap a boolean value stored in storage API updating the associated store value.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

    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 deleted file mode 100644 index fbb2963..0000000 --- a/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSLocalStorageBCMP.html +++ /dev/null @@ -1,50 +0,0 @@ -TJSLocalStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSLocalStorageBCMP

    Provides a TJSWebStorage instance for browser local storage using compressed MessagePack to base64.

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Methods

    entries -getItem -getStore -hasStore -keys -setItem -stores -swapItemBoolean -

    Constructors

    constructor

    Methods

    entries

    getItem

    • getItem(key, defaultValue?): any

    • Get value from the storage API.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

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

      -

    hasStore

    • hasStore(key): boolean

    • Returns whether a store has already been created for the given key.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

        -

      Returns boolean

    keys

    • keys(regex?): IterableIterator<string, any, any>

    • Returns an iterable for the session storage keys from existing stores.

      -

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by storage keys.

        -

      Returns IterableIterator<string, any, any>

      Iterable iterator of session storage keys.

      -

      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

    swapItemBoolean

    • swapItemBoolean(key, defaultValue?): boolean

    • Convenience method to swap a boolean value stored in storage API updating the associated store value.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

    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 deleted file mode 100644 index f687aa8..0000000 --- a/docs/classes/_runtime_svelte_store_web_storage_msgpack.TJSSessionStorageBCMP.html +++ /dev/null @@ -1,50 +0,0 @@ -TJSSessionStorageBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSSessionStorageBCMP

    Provides a TJSWebStorage instance for browser session storage using compressed MessagePack to base64.

    -
    -
    - -
    - - Hierarchy
    -     -
    -
    -
    -

    Constructors

    constructor -

    Methods

    entries -getItem -getStore -hasStore -keys -setItem -stores -swapItemBoolean -

    Constructors

    constructor

    Methods

    entries

    getItem

    • getItem(key, defaultValue?): any

    • Get value from the storage API.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

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

      -

    hasStore

    • hasStore(key): boolean

    • Returns whether a store has already been created for the given key.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

        -

      Returns boolean

    keys

    • keys(regex?): IterableIterator<string, any, any>

    • Returns an iterable for the session storage keys from existing stores.

      -

      Parameters

      • Optionalregex: RegExp

        Optional regular expression to filter by storage keys.

        -

      Returns IterableIterator<string, any, any>

      Iterable iterator of session storage keys.

      -

      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

    swapItemBoolean

    • swapItemBoolean(key, defaultValue?): boolean

    • Convenience method to swap a boolean value stored in storage API updating the associated store value.

      -

      Parameters

      • key: string

        Key to lookup in storage API.

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

    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 e138018..97ff0fa 100644 --- a/docs/classes/_runtime_svelte_util.TJSSvelteConfigUtil.html +++ b/docs/classes/_runtime_svelte_util.TJSSvelteConfigUtil.html @@ -1,17 +1,17 @@ -TJSSvelteConfigUtil | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class TJSSvelteConfigUtil

    Provides utilities to verify and parse TJSSvelteConfig configuration objects.

    +TJSSvelteConfigUtil | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class TJSSvelteConfigUtil

    Provides utilities to verify and parse TJSSvelteConfig configuration objects.

    Constructors

    constructor -

    Methods

    isConfig -parseConfig -

    Constructors

    constructor

    Methods

    StaticisConfig

    Methods

    isConfig +parseConfig +

    Constructors

    constructor

    Methods

    StaticisConfig

    • isConfig(
          config: unknown,
          options?: { raiseException?: boolean },
      ): config is TJSSvelteConfig

    • Validates config argument whether it is a valid TJSSvelteConfig.

      Parameters

      • config: unknown

        The potential config object to validate.

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

      -

    StaticparseConfig

    • parseConfig(config, thisArg?): TJSSvelteConfig

    • Parses a TyphonJS Svelte config object ensuring that classes specified are Svelte components and props are set +

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

    +

    StaticparseConfig

    • parseConfig(config: TJSSvelteConfig, thisArg?: any): 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.

      • OptionalthisArg: any

        This reference to set for invoking any props function.

      Returns TJSSvelteConfig

      The processed Svelte config object.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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 6d946f4..e62d64f 100644 --- a/docs/classes/_runtime_svelte_util.TJSSvelteUtil.html +++ b/docs/classes/_runtime_svelte_util.TJSSvelteUtil.html @@ -1,18 +1,18 @@ -TJSSvelteUtil | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    Class TJSSvelteUtil

    Various utilities to duck type / detect Svelte components and run outro transition while destroying a component externally.

    Constructors

    constructor -

    Methods

    isComponent -isHMRProxy -outroAndDestroy -

    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.

      +

    Methods

    isComponent +isHMRProxy +outroAndDestroy +

    Constructors

    constructor

    Methods

    StaticisComponent

    • isComponent(comp: unknown): 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.

      -

    StaticisHMRProxy

    • isHMRProxy(comp): boolean

    • Provides basic duck typing to determine if the provided object is a HMR ProxyComponent instance or class.

      +

    StaticisHMRProxy

    • isHMRProxy(comp: unknown): 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.

      -

    StaticoutroAndDestroy

    • outroAndDestroy(instance): Promise<any>

    • Runs outro transition then destroys Svelte component.

      +

    StaticoutroAndDestroy

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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.Hashing.html b/docs/classes/_runtime_util.Hashing.html index 8c9dfa1..294efb4 100644 --- a/docs/classes/_runtime_util.Hashing.html +++ b/docs/classes/_runtime_util.Hashing.html @@ -1,22 +1,22 @@ -Hashing | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Hashing

    Provides various utilities for generating hash codes for strings and UUIDs.

    +Hashing | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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 +

    Methods

    hashCode +isUuidv4 uuidv4 -

    Constructors

    constructor

    Methods

    StatichashCode

    • hashCode(str, seed?): number

    • Provides a solid string hashing algorithm.

      +

    Constructors

    constructor

    Methods

    StatichashCode

    • hashCode(str: string, seed?: number): number

    • Provides a solid string hashing algorithm.

      Sourced from: https://stackoverflow.com/a/52171480

      Parameters

      • str: string

        String to hash.

      • Optionalseed: number

        A seed value altering the hash.

      Returns number

      Hash code.

      -

    StaticisUuidv4

    • isUuidv4(uuid): boolean

    • Validates that the given string is formatted as a UUIDv4 string.

      +

    StaticisUuidv4

    • isUuidv4(uuid: string): boolean

    • Validates that the given string is formatted as a UUIDv4 string.

      Parameters

      • uuid: string

        UUID string to test.

      Returns boolean

      Is UUIDv4 string.

      -

    Staticuuidv4

    • uuidv4(): string

    • Generates a UUID v4 compliant ID. Please use a complete UUID generation package for guaranteed compliance.

      +

    Staticuuidv4

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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 8c1ad06..c29c532 100644 --- a/docs/classes/_runtime_util.Strings.html +++ b/docs/classes/_runtime_util.Strings.html @@ -1,14 +1,14 @@ -Strings | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Strings

    Provides utility functions for strings.

    +Strings | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Staticescape

    • 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): 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.

      -

    Staticnormalize

    • normalize(string): string

    • Normalizes a string.

      +

    Staticnormalize

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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 d8c8035..daac441 100644 --- a/docs/classes/_runtime_util.Timing.html +++ b/docs/classes/_runtime_util.Timing.html @@ -1,29 +1,29 @@ -Timing | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class Timing

    Provides timing related higher-order functions.

    +Timing | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    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 +doubleClick +

    Constructors

    constructor

    Methods

    Staticdebounce

    • debounce<Args>(
          callback: (...args: Args[]) => void,
          delay: number,
      ): (...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();
+

      Type Parameters

      • Args

      Parameters

      • callback: (...args: Args[]) => void

        A function to execute once the debounced threshold has been passed.

        +
      • delay: number

        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');
+

      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 +

    StaticdoubleClick

    • doubleClick(
          opts: {
              delay?: number;
              double?: (event: Event) => void;
              single?: (event: Event) => void;
          },
      ): (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)
      });
+

      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.

          +
        • Optionalsingle?: (event: Event) => void

          Single click callback.

          +

      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)
      });
      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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_a11y.A11yHelper.html b/docs/classes/_runtime_util_a11y.A11yHelper.html index 4a229d3..e4d56e6 100644 --- a/docs/classes/_runtime_util_a11y.A11yHelper.html +++ b/docs/classes/_runtime_util_a11y.A11yHelper.html @@ -1,87 +1,87 @@ -A11yHelper | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class A11yHelper

    Provides several helpful utility methods for accessibility and keyboard navigation.

    +A11yHelper | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    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

    Accessors

    debug -prefersReducedMotion -

    Methods

    applyFocusSource -getFirstFocusableElement -getFocusableElements -getFocusSource -getLastFocusableElement -isFocusable -isFocusSource -isFocusTarget -isFocusWithin -isParentHidden -

    Constructors

    constructor

    Accessors

    Staticdebug

    • get debug(): boolean

    • Returns boolean

      Global debugging enabled.

      -
    • set debug(debug): void

    • Parameters

      • debug: boolean

        Global debug enabled

        -

      Returns void

    StaticprefersReducedMotion

    • get prefersReducedMotion(): boolean

    • Runs a media query to determine if the user / OS configuration is set up for reduced motion / animation.

      +prefersReducedMotion +

    Methods

    applyFocusSource +getFirstFocusableElement +getFocusableElements +getFocusSource +getLastFocusableElement +isFocusable +isFocusSource +isFocusTarget +isFocusWithin +isParentHidden +

    Constructors

    constructor

    Accessors

    Staticdebug

    • get debug(): boolean

    • Returns boolean

      Global debugging enabled.

      +
    • set debug(debug: boolean): void

    • Parameters

      • debug: boolean

        Global debug enabled

        +

      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

    StaticapplyFocusSource

    • applyFocusSource(options): void

    • Apply focus to the HTMLElement / SVGElement targets in a given A11yFocusSource data object. An iterable list +

    Methods

    StaticapplyFocusSource

    • applyFocusSource(
          options: A11yFocusSource | { focusSource: A11yFocusSource },
      ): 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 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.

      -

      Parameters

      Returns void

    StaticgetFirstFocusableElement

    • getFirstFocusableElement(element?, options?): FocusableElement

    • Returns first focusable element within a specified element.

      -

      Parameters

    StaticgetFirstFocusableElement

    StaticgetFocusableElements

    • getFocusableElements(element?, options?): FocusableElement[]

    • Returns all focusable elements within a specified element.

      -

      Parameters

    StaticgetFocusableElements

    StaticgetFocusSource

    • getFocusSource(options): A11yFocusSource

    • Gets a A11yFocusSource object from the given DOM event allowing for optional X / Y screen space overrides. +

    StaticgetFocusSource

    • getFocusSource(
          options: {
              debug?: boolean;
              event?: MouseEvent | KeyboardEvent;
              focusEl?: string | FocusableElement;
              x?: number;
              y?: number;
          },
      ): A11yFocusSource

    • 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 A11yHelper.applyFocusSource the target focus +list of focus targets. When A11yFocusSource is applied by A11yHelper.applyFocusSource the target focus list is iterated through until a connected target is found and focus applied.

      -

      Parameters

    StaticgetLastFocusableElement

    • getLastFocusableElement(element?, options?): FocusableElement

    • Returns first focusable element within a specified element.

      -

      Parameters

    StaticgetLastFocusableElement

    StaticisFocusable

    • isFocusable(el, options?): boolean

    • Tests if the given element is focusable.

      +

    StaticisFocusable

    • isFocusable(
          el: unknown,
          options?: {
              anchorHref?: boolean;
              ignoreClasses?: Iterable<string, any, any>;
          },
      ): boolean

    • Tests if the given element is focusable.

      Parameters

      • el: unknown

        Element to test.

        -
      • Optionaloptions: {
            anchorHref?: boolean;
            ignoreClasses?: Iterable<string, any, any>;
        }

        Optional parameters.

        -
        • OptionalanchorHref?: boolean

          When true anchors must have an HREF.

          -
        • OptionalignoreClasses?: Iterable<string, any, any>

          Iterable list of classes to ignore elements.

          +
        • Optionaloptions: { anchorHref?: boolean; ignoreClasses?: Iterable<string, any, any> }

          Optional parameters.

          +
          • OptionalanchorHref?: boolean

            When true anchors must have an HREF.

            +
          • OptionalignoreClasses?: Iterable<string, any, any>

            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.

        +

    StaticisFocusSource

    • isFocusSource(data: string | Element): 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.

      -

    StaticisFocusTarget

    • isFocusTarget(element): boolean

    • Tests if the given element is a Element node and has a focus method.

      +

    StaticisFocusTarget

    • isFocusTarget(element: 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.

      -

    StaticisFocusWithin

    • isFocusWithin(element): boolean

    • Perform a parent traversal from the current active element attempting to match the given element to test whether +

    StaticisFocusWithin

    • isFocusWithin(element: Element): 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.

      Returns boolean

      Whether there is focus within the given element.

      -

    StaticisParentHidden

    • isParentHidden(element, stopElement?): boolean

    • Traverses the given element's parent elements to check if any parent has offsetWidth and offsetHeight of 0, +

    StaticisParentHidden

    • isParentHidden(element: Element, stopElement?: Element): boolean

    • Traverses the given element's parent elements to check if any parent has offsetWidth and offsetHeight of 0, indicating that a parent element is hidden. If a parent element is hidden, the given element is also considered hidden. This is a reasonably efficient check and can be enabled as a filter step in conjunction with focusable -element detection methods like A11yHelper.getFocusableElements.

      +element detection methods like A11yHelper.getFocusableElements.

      Parameters

      • element: Element

        The starting element to check.

      • OptionalstopElement: Element

        The stopping parent element for traversal. If not defined, document.body is used as the stopping element.

      Returns boolean

      true if a parent element of the given element is hidden; otherwise, false.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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_async.ImageData.html b/docs/classes/_runtime_util_async.ImageData.html index 75d4dc2..8cbb179 100644 --- a/docs/classes/_runtime_util_async.ImageData.html +++ b/docs/classes/_runtime_util_async.ImageData.html @@ -1,14 +1,14 @@ -ImageData | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class ImageData

    Provides utility functions for retrieving data about images.

    +ImageData | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class ImageData

    Provides utility functions for retrieving data about images.

    Constructors

    constructor -

    Methods

    getDimensions -

    Constructors

    constructor

    Methods

    StaticgetDimensions

    • getDimensions(urls, options?): Promise<{
          fulfilled: {
              height: number;
              url: string;
              width: number;
          }[];
          rejected: {
              url: string;
          }[];
      }>

    • Loads given URLs into image elements returning those that resolved with width & height dimensions. This is useful +

    Methods

    getDimensions +

    Constructors

    constructor

    Methods

    StaticgetDimensions

    • getDimensions(
          urls:
              | string
              | { url?: string }
              | Iterable<string | { url?: string }, any, any>,
          options?: { accessor?: string; warn?: boolean },
      ): Promise<
          {
              fulfilled: { height: number; url: string; width: number }[];
              rejected: { url: string }[];
          },
      >

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

      -

      Parameters

      • urls: string | {
            url?: string;
        } | Iterable<string | {
            url?: string;
        }, any, any>

        A list of image URLS to load or +

        Parameters

        • urls: string | { url?: string } | Iterable<string | { url?: string }, any, any>

          A list of image URLS to load or object with an url property.

          -
        • Optionaloptions: {
              accessor?: string;
              warn?: boolean;
          }

          Optional options.

          -
          • Optionalaccessor?: string

            Accessor string to access child attribute when urls entry contains +

          • Optionaloptions: { accessor?: string; warn?: boolean }

            Optional options.

            +
            • Optionalaccessor?: string

              Accessor string to access child attribute when urls entry contains objects.

              -
            • Optionalwarn?: boolean

              Log debug warnings when a target URL can not be determined; default: false.

              -

        Returns Promise<{
            fulfilled: {
                height: number;
                url: string;
                width: number;
            }[];
            rejected: {
                url: string;
            }[];
        }>

        An object with fulfilled and rejected requests.

        -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +
  • Optionalwarn?: boolean

    Log debug warnings when a target URL can not be determined; default: false.

    +

    • Returns Promise<
        {
            fulfilled: { height: number; url: string; width: number }[];
            rejected: { url: string }[];
        },
    >

    An object with fulfilled and rejected requests.

    +

    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 1cbadfe..3ade2b6 100644 --- a/docs/classes/_runtime_util_async.ManagedPromise.html +++ b/docs/classes/_runtime_util_async.ManagedPromise.html @@ -1,31 +1,31 @@ -ManagedPromise | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 -

    Accessors

    isActive -isProcessing +

    Accessors

    isActive +isProcessing logging

    Methods

    create get reject resolve -

    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.

      -

    Staticlogging

    • get logging(): boolean

    • Returns boolean

      Whether global logging is enabled.

      -
    • set logging(logging): void

    • Sets global logging enabled state.

      +

    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.

      +

    Staticlogging

    • get logging(): boolean

    • Returns boolean

      Whether global logging is enabled.

      +
    • set logging(logging: boolean): 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

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

    Methods

    create

    • create<T>(opts?: { reuse?: boolean }): 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.

      +

    reject

    • reject(result?: any): boolean

    • Rejects the current Promise if applicable.

      Parameters

      • Optionalresult: any

        Result to reject.

      Returns boolean

      Was the promise rejected.

      -

    resolve

    • resolve(result?): boolean

    • Resolves the current Promise if applicable.

      +

    resolve

    • resolve(result?: any): boolean

    • Resolves the current Promise if applicable.

      Parameters

      • Optionalresult: any

        Result to resolve.

      Returns boolean

      Was the promise resolved.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods
    \ 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 fee1b9d..3b8b0d2 100644 --- a/docs/classes/_runtime_util_browser.BrowserSupports.html +++ b/docs/classes/_runtime_util_browser.BrowserSupports.html @@ -1,9 +1,9 @@ -BrowserSupports | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 -

    Accessors

    containerQueries -

    Constructors

    constructor

    Accessors

    StaticcontainerQueries

    • get containerQueries(): boolean

    • Check for container query support.

      +

    Accessors

    containerQueries +

    Constructors

    constructor

    Accessors

    StaticcontainerQueries

    • get containerQueries(): boolean

    • Check for container query support.

      Returns boolean

      True if container queries supported.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    \ 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 0e848ce..0dbea1e 100644 --- a/docs/classes/_runtime_util_browser.ClipboardAccess.html +++ b/docs/classes/_runtime_util_browser.ClipboardAccess.html @@ -1,18 +1,18 @@ -ClipboardAccess | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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
    +

    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 -

    Methods

    readText -writeText -

    Constructors

    constructor

    Methods

    StaticreadText

    • readText(activeWindow?): Promise<string>

    • Uses navigator.clipboard if available to read text from the clipboard.

      +

    Methods

    readText +writeText +

    Constructors

    constructor

    Methods

    StaticreadText

    • readText(activeWindow?: Window): 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

      • OptionalactiveWindow: Window

        Optional active current window.

      Returns Promise<string>

      The current clipboard text or undefined.

      -

    StaticwriteText

    • writeText(text, activeWindow?): Promise<boolean>

    • Uses navigator.clipboard if available then falls back to document.execCommand('copy') if available to copy +

    StaticwriteText

    • writeText(text: string, activeWindow?: Window): 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.

      • OptionalactiveWindow: Window

        Optional active current window.

      Returns Promise<boolean>

      Copy successful.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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.CrossWindow.html b/docs/classes/_runtime_util_browser.CrossWindow.html index c5641a3..227c709 100644 --- a/docs/classes/_runtime_util_browser.CrossWindow.html +++ b/docs/classes/_runtime_util_browser.CrossWindow.html @@ -1,5 +1,5 @@ -CrossWindow | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class CrossWindow

    Provides cross window checks for DOM nodes / elements, events, and essential duck typing for any class based object +CrossWindow | TyphonJS Runtime Library (FVTT) 0.2.0

    +

    Class CrossWindow

    Provides cross window checks for DOM nodes / elements, events, and essential duck typing for any class based object with a constructor name. The impetus is that certain browsers such as Chrome and Firefox behave differently when performing instanceof checks when elements are moved between browser windows. With Firefox in particular the entire JS runtime can not use instanceof checks as the instances of fundamental DOM elements differ between @@ -8,122 +8,122 @@ app instances in a separate browser window. In this case for essential DOM element and event checks it is necessary to employ the workarounds found in CrossWindow.

    Constructors

    constructor -

    Methods

    getActiveElement -getDocument -getWindow -isCtorName -isDocument -isDocumentFragment -isElement -isEvent -isFocusableHTMLElement -isHTMLAnchorElement -isHTMLElement -isMap -isNode -isPointerEvent -isPromise -isRegExp -isSet -isShadowRoot -isSVGElement -isUIEvent -isURL -isUserInputEvent -isWindow -

    Constructors

    constructor

    Methods

    StaticgetActiveElement

    • getActiveElement(target, options?): Element

    • Convenience method to retrieve the document.activeElement value in the current Window context of a DOM Node / +

    Methods

    getActiveElement +getDocument +getWindow +isCtorName +isDocument +isDocumentFragment +isElement +isEvent +isFocusableHTMLElement +isHTMLAnchorElement +isHTMLElement +isMap +isNode +isPointerEvent +isPromise +isRegExp +isSet +isShadowRoot +isSVGElement +isUIEvent +isURL +isUserInputEvent +isWindow +

    Constructors

    constructor

    Methods

    StaticgetActiveElement

    • getActiveElement(
          target: EventTarget | Node | Document | Window | UIEvent,
          options?: { throws?: boolean },
      ): Element

    • Convenience method to retrieve the document.activeElement value in the current Window context of a DOM Node / Element, EventTarget, Document, or Window.

      -

      Parameters

      • target:
            | EventTarget
            | Node
            | Document
            | Window
            | UIEvent

        DOM Node / Element, EventTarget, Document, +

        Parameters

        • target: EventTarget | Node | Document | Window | UIEvent

          DOM Node / Element, EventTarget, Document, UIEvent or Window to query.

          -
        • Optionaloptions: {
              throws?: boolean;
          }

          Options.

          -
          • Optionalthrows?: boolean

            When true and target is invalid throw an exception. If false and the +

          • Optionaloptions: { throws?: boolean }

            Options.

            +
            • Optionalthrows?: boolean

              When true and target is invalid throw an exception. If false and the target is invalid undefined is returned; default: true.

        Returns Element

        Active element or undefined when throws option is false and the target is invalid.

        -

        Throws

        TypeError Target must be a DOM Node / Element, Document, UIEvent, or Window.

        -

    StaticgetDocument

    • getDocument(target, options?): Document

    • Convenience method to retrieve the Document value in the current context of a DOM Node / Element, EventTarget, +

      Throws

      TypeError Target must be a DOM Node / Element, Document, UIEvent, or Window.

      +

    StaticgetDocument

    • getDocument(
          target: EventTarget | Node | Document | Window | UIEvent,
          options?: { throws?: boolean },
      ): Document

    • Convenience method to retrieve the Document value in the current context of a DOM Node / Element, EventTarget, Document, UIEvent, or Window.

      -

      Parameters

      • target:
            | EventTarget
            | Node
            | Document
            | Window
            | UIEvent

        DOM Node / Element, EventTarget, Document, +

        Parameters

        • target: EventTarget | Node | Document | Window | UIEvent

          DOM Node / Element, EventTarget, Document, UIEvent or Window to query.

          -
        • Optionaloptions: {
              throws?: boolean;
          }

          Options.

          -
          • Optionalthrows?: boolean

            When true and target is invalid throw an exception. If false and the +

          • Optionaloptions: { throws?: boolean }

            Options.

            +
            • Optionalthrows?: boolean

              When true and target is invalid throw an exception. If false and the target is invalid undefined is returned; default: true.

        Returns Document

        Active document or undefined when throws option is false and the target is invalid.

        -

        Throws

        TypeError Target must be a DOM Node / Element, Document, UIEvent, or Window.

        -

    StaticgetWindow

    • getWindow(target, options?): Window

    • Convenience method to retrieve the Window value in the current context of a DOM Node / Element, EventTarget, +

      Throws

      TypeError Target must be a DOM Node / Element, Document, UIEvent, or Window.

      +

    StaticgetWindow

    • getWindow(
          target: EventTarget | Node | Document | Window | UIEvent,
          options?: { throws?: boolean },
      ): Window

    • Convenience method to retrieve the Window value in the current context of a DOM Node / Element, EventTarget, Document, or Window.

      -

      Parameters

      • target:
            | EventTarget
            | Node
            | Document
            | Window
            | UIEvent

        DOM Node / Element, EventTarget, Document, +

        Parameters

        • target: EventTarget | Node | Document | Window | UIEvent

          DOM Node / Element, EventTarget, Document, UIEvent or Window to query.

          -
        • Optionaloptions: {
              throws?: boolean;
          }

          Options.

          -
          • Optionalthrows?: boolean

            When true and target is invalid throw an exception. If false and the +

          • Optionaloptions: { throws?: boolean }

            Options.

            +
            • Optionalthrows?: boolean

              When true and target is invalid throw an exception. If false and the target is invalid undefined is returned; default: true.

        Returns Window

        Active window or undefined when throws option is false and the target is invalid.

        -

        Throws

        TypeError Target must be a DOM Node / Element, Document, UIEvent, or Window.

        -

    StaticisCtorName

    • isCtorName(target, types): boolean

    • Provides basic type checking by constructor name(s) for objects. This can be useful when checking multiple +

      Throws

      TypeError Target must be a DOM Node / Element, Document, UIEvent, or Window.

      +

    StaticisCtorName

    • isCtorName(target: unknown, types: string | Set<string>): boolean

    • Provides basic type checking by constructor name(s) for objects. This can be useful when checking multiple constructor names against a provided Set.

      Parameters

      • target: unknown

        Object to test for constructor name.

        -
      • types: string | Set<string>

        Specific constructor name or Set of constructor names to match.

        +
      • types: string | Set<string>

        Specific constructor name or Set of constructor names to match.

      Returns boolean

      Does the provided object constructor name match the types provided.

      -

    StaticisDocument

    • isDocument(target): target is Document

    • Provides basic prototype string type checking if target is a Document.

      +

    StaticisDocument

    • isDocument(target: unknown): target is Document

    • Provides basic prototype string type checking if target is a Document.

      Parameters

      • target: unknown

        A potential Document to test.

        -

      Returns target is Document

      Is target a Document.

      -

    StaticisDocumentFragment

    • isDocumentFragment(target): target is DocumentFragment

    • Provides precise type checking if target is a DocumentFragment.

      +

    Returns target is Document

    Is target a Document.

    +

    StaticisDocumentFragment

    • isDocumentFragment(target: unknown): target is DocumentFragment

    • Provides precise type checking if target is a DocumentFragment.

      Parameters

      • target: unknown

        A potential DocumentFragment to test.

        -

      Returns target is DocumentFragment

      Is target a DocumentFragment.

      -

    StaticisElement

    • isElement(target): target is Element

    • Provides precise type checking if target is an Element.

      +

    Returns target is DocumentFragment

    Is target a DocumentFragment.

    +

    StaticisElement

    • isElement(target: unknown): target is Element

    • Provides precise type checking if target is an Element.

      Parameters

      • target: unknown

        A potential Element to test.

        -

      Returns target is Element

      Is target an Element.

      -

    StaticisEvent

    • isEvent(target, types?): target is Event

    • Provides basic duck type checking for Event signature and optional constructor name(s).

      +

    Returns target is Element

    Is target an Element.

    +

    StaticisEvent

    • isEvent(target: unknown, types?: string | Set<string>): target is Event

    • Provides basic duck type checking for Event signature and optional constructor name(s).

      Parameters

      • target: unknown

        A potential DOM event to test.

        -
      • Optionaltypes: string | Set<string>

        Specific constructor name or Set of constructor names to match.

        -

      Returns target is Event

      Is target an Event with optional constructor name check.

      -

    StaticisFocusableHTMLElement

    • isFocusableHTMLElement(target): boolean

    • Ensures that the given target is an instanceof all known DOM elements that are focusable. Please note that +

    • Optionaltypes: string | Set<string>

      Specific constructor name or Set of constructor names to match.

      +

    Returns target is Event

    Is target an Event with optional constructor name check.

    +

    StaticisFocusableHTMLElement

    • isFocusableHTMLElement(target: unknown): boolean

    • Ensures that the given target is an instanceof all known DOM elements that are focusable. Please note that additional checks are required regarding focusable state; use A11yHelper.isFocusable for a complete check.

      Parameters

      • target: unknown

        Target to test for instanceof focusable HTML element.

      Returns boolean

      Is target an instanceof a focusable DOM element.

      -

    StaticisHTMLAnchorElement

    • isHTMLAnchorElement(target): target is HTMLAnchorElement

    • Provides precise type checking if target is a HTMLAnchorElement.

      +

    StaticisHTMLAnchorElement

    • isHTMLAnchorElement(target: unknown): target is HTMLAnchorElement

    • Provides precise type checking if target is a HTMLAnchorElement.

      Parameters

      • target: unknown

        A potential HTMLAnchorElement to test.

        -

      Returns target is HTMLAnchorElement

      Is target a HTMLAnchorElement.

      -

    StaticisHTMLElement

    • isHTMLElement(target): target is HTMLElement

    • Provides precise type checking if target is a HTMLElement.

      +

    Returns target is HTMLAnchorElement

    Is target a HTMLAnchorElement.

    +

    StaticisHTMLElement

    • isHTMLElement(target: unknown): target is HTMLElement

    • Provides precise type checking if target is a HTMLElement.

      Parameters

      • target: unknown

        A potential HTMLElement to test.

        -

      Returns target is HTMLElement

      Is target a HTMLElement.

      -

    StaticisMap

    • isMap(target): target is Map<any, any>

    • Provides basic prototype string type checking if target is a Map.

      +

    Returns target is HTMLElement

    Is target a HTMLElement.

    +

    StaticisMap

    • isMap(target: unknown): target is Map<any, any>

    • Provides basic prototype string type checking if target is a Map.

      Parameters

      • target: unknown

        A potential Map to test.

        -

      Returns target is Map<any, any>

      Is target a Map.

      -

    StaticisNode

    • isNode(target): target is Node

    • Provides precise type checking if target is a Node.

      +

    Returns target is Map<any, any>

    Is target a Map.

    +

    StaticisNode

    • isNode(target: unknown): target is Node

    • Provides precise type checking if target is a Node.

      Parameters

      • target: unknown

        A potential Node to test.

        -

      Returns target is Node

      Is target a DOM Node.

      -

    StaticisPointerEvent

    • isPointerEvent(target): target is PointerEvent

    • Provides basic duck type checking for Event signature for standard mouse / pointer events including +

    Returns target is Node

    Is target a DOM Node.

    +

    StaticisPointerEvent

    • isPointerEvent(target: unknown): target is PointerEvent

    • Provides basic duck type checking for Event signature for standard mouse / pointer events including MouseEvent and PointerEvent.

      Parameters

      • target: unknown

        A potential DOM event to test.

        -

      Returns target is PointerEvent

      Is target a MouseEvent or PointerEvent.

      -

    StaticisPromise

    • isPromise(target): target is Promise<any>

    • Provides basic prototype string type checking if target is a Promise.

      +

    Returns target is PointerEvent

    Is target a MouseEvent or PointerEvent.

    +

    StaticisPromise

    • isPromise(target: unknown): target is Promise<any>

    • Provides basic prototype string type checking if target is a Promise.

      Parameters

      • target: unknown

        A potential Promise to test.

        -

      Returns target is Promise<any>

      Is target a Promise.

      -

    StaticisRegExp

    • isRegExp(target): target is RegExp

    • Provides basic prototype string type checking if target is a RegExp.

      +

    Returns target is Promise<any>

    Is target a Promise.

    +

    StaticisRegExp

    • isRegExp(target: unknown): target is RegExp

    • Provides basic prototype string type checking if target is a RegExp.

      Parameters

      • target: unknown

        A potential RegExp to test.

        -

      Returns target is RegExp

      Is target a RegExp.

      -

    StaticisSet

    • isSet(target): target is Set<any>

    • Provides basic prototype string type checking if target is a Set.

      +

    Returns target is RegExp

    Is target a RegExp.

    +

    StaticisSet

    • isSet(target: unknown): target is Set<any>

    • Provides basic prototype string type checking if target is a Set.

      Parameters

      • target: unknown

        A potential Set to test.

        -

      Returns target is Set<any>

      Is target a Set.

      -

    StaticisShadowRoot

    • isShadowRoot(target): target is ShadowRoot

    • Provides precise type checking if target is a ShadowRoot.

      +

    Returns target is Set<any>

    Is target a Set.

    +

    StaticisShadowRoot

    • isShadowRoot(target: unknown): target is ShadowRoot

    • Provides precise type checking if target is a ShadowRoot.

      Parameters

      • target: unknown

        A potential ShadowRoot to test.

        -

      Returns target is ShadowRoot

      Is target a ShadowRoot.

      -

    StaticisSVGElement

    • isSVGElement(target): target is SVGElement

    • Provides precise type checking if target is a SVGElement.

      +

    Returns target is ShadowRoot

    Is target a ShadowRoot.

    +

    StaticisSVGElement

    • isSVGElement(target: unknown): target is SVGElement

    • Provides precise type checking if target is a SVGElement.

      Parameters

      • target: unknown

        A potential SVGElement to test.

        -

      Returns target is SVGElement

      Is target a SVGElement.

      -

    StaticisUIEvent

    • isUIEvent(target): target is UIEvent

    • Provides basic duck type checking for Event signature for all UI events.

      +

    Returns target is SVGElement

    Is target a SVGElement.

    +

    StaticisUIEvent

    StaticisURL

    • isURL(target): target is URL

    • Provides basic prototype string type checking if target is a URL.

      +

    Returns target is UIEvent

    Is target a UIEvent.

    +

    See

    https://developer.mozilla.org/en-US/docs/Web/API/UIEvent

    +

    StaticisURL

    • isURL(target: unknown): target is URL

    • Provides basic prototype string type checking if target is a URL.

      Parameters

      • target: unknown

        A potential URL to test.

        -

      Returns target is URL

      Is target a URL.

      -

    StaticisUserInputEvent

    • isUserInputEvent(target): target is PointerEvent | MouseEvent | KeyboardEvent

    • Provides basic duck type checking for Event signature for standard user input events including KeyboardEvent, +

    Returns target is URL

    Is target a URL.

    +

    StaticisUserInputEvent

    • isUserInputEvent(
          target: unknown,
      ): target is PointerEvent | MouseEvent | KeyboardEvent

    • Provides basic duck type checking for Event signature for standard user input events including KeyboardEvent, MouseEvent, and PointerEvent.

      Parameters

      • target: unknown

        A potential DOM event to test.

        -

      Returns target is PointerEvent | MouseEvent | KeyboardEvent

      Is target a Keyboard, MouseEvent, or +

    Returns target is PointerEvent | MouseEvent | KeyboardEvent

    Is target a Keyboard, MouseEvent, or PointerEvent.

    -

    StaticisWindow

    • isWindow(target): target is Window

    • Provides basic prototype string type checking if target is a Window.

      +

    StaticisWindow

    • isWindow(target: unknown): target is Window

    • Provides basic prototype string type checking if target is a Window.

      Parameters

      • target: unknown

        A potential Window to test.

        -

      Returns target is Window

      Is target a Window.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file +

    Returns target is Window

    Is target a Window.

    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ No newline at end of file diff --git a/docs/classes/_runtime_util_browser.URLParser.html b/docs/classes/_runtime_util_browser.URLParser.html index 901e395..a9c309a 100644 --- a/docs/classes/_runtime_util_browser.URLParser.html +++ b/docs/classes/_runtime_util_browser.URLParser.html @@ -1,14 +1,14 @@ -URLParser | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class URLParser

    Provides a utility function to parse / construct fully qualified URL instances from a URL string.

    +URLParser | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class URLParser

    Provides a utility function to parse / construct fully qualified URL instances from a URL string.

    Constructors

    constructor

    Methods

    parse -

    Constructors

    constructor

    Methods

    Staticparse

    • parse(options): URL

    • Parses a URL string converting it to a fully qualified URL. If URL is an existing URL instance it is returned +

    Constructors

    constructor

    Methods

    Staticparse

    • parse(options: { base?: string; routePrefix?: string; url: string | URL }): URL

    • Parses a URL string converting it to a fully qualified URL. If URL is an existing URL instance it is returned immediately. Optionally you may construct a fully qualified URL from a relative base origin / path or with a route prefix added to the current location origin.

      -

      Parameters

      • options: {
            base?: string;
            routePrefix?: string;
            url: string | URL;
        }

        Options.

        -
        • Optionalbase?: string

          Optional fully qualified base path for relative URL construction.

          -
        • OptionalroutePrefix?: string

          Optional route prefix to add to location origin for absolute URL strings +

          Parameters

          • options: { base?: string; routePrefix?: string; url: string | URL }

            Options.

            +
            • Optionalbase?: string

              Optional fully qualified base path for relative URL construction.

              +
            • OptionalroutePrefix?: string

              Optional route prefix to add to location origin for absolute URL strings when base is not defined.

              -
            • url: string | URL

              URL string to convert to a URL.

              +
            • url: string | URL

              URL string to convert to a URL.

          Returns URL

          Parsed URL or null if url is not parsed.

          -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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_dom_observer.ResizeObserverManager.html b/docs/classes/_runtime_util_dom_observer.ResizeObserverManager.html index f683a9e..399df9f 100644 --- a/docs/classes/_runtime_util_dom_observer.ResizeObserverManager.html +++ b/docs/classes/_runtime_util_dom_observer.ResizeObserverManager.html @@ -1,5 +1,5 @@ -ResizeObserverManager | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 @@ -8,21 +8,21 @@

    Methods

    add clear remove -updateCache -

    Constructors

    constructor

    Methods

    add

    Constructors

    constructor

    Methods

    add

    • add(el: HTMLElement, target: ResizeTarget): 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

      • el: HTMLElement

        The element to observe.

      • target: ResizeTarget

        A target that contains one of several mechanisms for updating resize data.

        -

      Returns void

    clear

    • clear(): void

    • Clears and unobserves all currently tracked elements and managed targets.

      -

      Returns void

    remove

    Returns void

    clear

    • clear(): void

    • Clears and unobserves all currently tracked elements and managed targets.

      +

      Returns void

    remove

    • remove(el: HTMLElement, target?: ResizeTarget): 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

      • el: HTMLElement

        Element to remove from monitoring.

      • Optionaltarget: ResizeTarget

        A specific target to remove from monitoring.

        -

      Returns void

    updateCache

    • updateCache(el): void

    • Provides a function that when invoked with an element updates the cached styles for each subscriber of the +

    Returns void

    updateCache

    • updateCache(el: HTMLElement): 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

    On This Page

    Constructors
    Methods
    \ 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_dom_style.StyleParse.html b/docs/classes/_runtime_util_dom_style.StyleParse.html index 0e584c9..3a693a3 100644 --- a/docs/classes/_runtime_util_dom_style.StyleParse.html +++ b/docs/classes/_runtime_util_dom_style.StyleParse.html @@ -1,15 +1,15 @@ -StyleParse | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    Class StyleParse

    Provides resources for parsing style strings.

    +StyleParse | TyphonJS Runtime Library (FVTT) 0.2.0
    +

    Class StyleParse

    Provides resources for parsing style strings.

    Constructors

    constructor

    Methods

    pixels -remPixels -

    Constructors

    constructor

    Methods

    Staticpixels

    • pixels(value): number

    • Parses a pixel string / computed styles. Ex. 100px returns 100.

      +remPixels +

    Constructors

    constructor

    Methods

    Staticpixels

    • pixels(value: string): 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.

      -

    StaticremPixels

    • remPixels(multiplier?, options?): number

    • Returns the pixel value for 1rem based on the root document element. You may apply an optional multiplier.

      +

    StaticremPixels

    • remPixels(multiplier?: number, options?: { targetDocument?: Document }): number

    • Returns the pixel value for 1rem based on the root document element. You may apply an optional multiplier.

      Parameters

      • Optionalmultiplier: number

        Optional multiplier to apply to rem pixel value; default: 1.

        -
      • Optionaloptions: {
            targetDocument?: Document;
        }

        Optional parameters.

        -
        • OptionaltargetDocument?: Document

          The target DOM Document if different from the main +

        • Optionaloptions: { targetDocument?: Document }

          Optional parameters.

          +
          • OptionaltargetDocument?: Document

            The target DOM 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.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    \ 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_dom_style.TJSStyleManager.html b/docs/classes/_runtime_util_dom_style.TJSStyleManager.html index 1ade190..b3d76af 100644 --- a/docs/classes/_runtime_util_dom_style.TJSStyleManager.html +++ b/docs/classes/_runtime_util_dom_style.TJSStyleManager.html @@ -1,5 +1,5 @@ -TJSStyleManager | TyphonJS Runtime Library (FVTT) 0.2.0
    -

    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

    +

    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 @@ -7,42 +7,42 @@ instance is created and there is an existing instance with a version that is lower than the current instance all CSS rules are removed letting the higher version to take precedence. This isn't a perfect system and requires thoughtful 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.

    +CSS variables. It is recommended to always set overwrite option of TJSStyleManager.setProperty and +TJSStyleManager.setProperties to false when loading initial values.

    Constructors

    constructor -

    Accessors

    cssText +

    Accessors

    cssText version

    Methods

    clone get -getProperty -removeProperties -removeProperty -setProperties -setProperty -

    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.

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

    Constructors

    constructor

    • new TJSStyleManager(
          opts?: {
              docKey: string;
              document?: Document;
              selector?: string;
              version?: number;
          },
      ): 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.

          +
        • 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?: 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

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

        +

      get

      • get(): {}

      • Returns {}

      getProperty

      • getProperty(key: string): string

      • Gets a particular CSS variable.

        Parameters

        • key: string

          CSS variable property key.

        Returns string

        Returns CSS variable value.

        -

      removeProperties

      • removeProperties(keys): void

      • Removes the property keys specified. If keys is an iterable list then all property keys in the list are removed.

        -

        Parameters

        • keys: Iterable<string, any, any>

          The property keys to remove.

          -

        Returns void

      removeProperty

      • removeProperty(key): string

      • Removes a particular CSS variable.

        +

      removeProperties

      • removeProperties(keys: Iterable<string, any, any>): void

      • Removes the property keys specified. If keys is an iterable list then all property keys in the list are removed.

        +

        Parameters

        • keys: Iterable<string, any, any>

          The property keys to remove.

          +

        Returns void

      removeProperty

      • removeProperty(key: string): string

      • Removes a particular CSS variable.

        Parameters

        • key: string

          CSS variable property key.

        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
        • Optionaloverwrite: boolean

          When true overwrites any existing values.

          -

        Returns void

      setProperty

      • setProperty(key, value, overwrite?): void

      • Sets a particular property.

        +

      setProperties

      • setProperties(rules: { [key: string]: string }, overwrite?: boolean): void

      • Set rules by property / value; useful for CSS variables.

        +

        Parameters

        • rules: { [key: string]: string }

          An object with property / value string pairs to load.

          +
        • Optionaloverwrite: boolean

          When true overwrites any existing values.

          +

        Returns void

      setProperty

      • setProperty(key: string, value: string, overwrite?: boolean): void

      • Sets a particular property.

        Parameters

        • key: string

          CSS variable property key.

        • value: string

          CSS variable value.

        • Optionaloverwrite: boolean

          Overwrite any existing value.

          -

        Returns void

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ 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_util_html_striptags.StateMachine.html b/docs/classes/_runtime_util_html_striptags.StateMachine.html index ccf2240..2e2d52d 100644 --- a/docs/classes/_runtime_util_html_striptags.StateMachine.html +++ b/docs/classes/_runtime_util_html_striptags.StateMachine.html @@ -1,4 +1,4 @@ -StateMachine | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class StateMachine

      Constructors

      constructor +StateMachine | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class StateMachine

      Constructors

      constructor

      Methods

      consume -

      Constructors

      constructor

      Methods

      consume

      • consume(text): string

      • Parameters

        • text: string

        Returns string

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Constructors

      constructor

      Methods

      consume

      • consume(text: string): string

      • Parameters

        • text: string

        Returns string

      Settings

      Member Visibility

      On This Page

      Constructors
      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 deleted file mode 100644 index 924b520..0000000 --- a/docs/classes/_runtime_util_loader_module.ModuleLoadError.html +++ /dev/null @@ -1,28 +0,0 @@ -ModuleLoadError | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 -message -name -stack? -prepareStackTrace? -stackTraceLimit -

      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

      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 deleted file mode 100644 index b0ef82a..0000000 --- a/docs/classes/_runtime_util_loader_module.ModuleLoader.html +++ /dev/null @@ -1,10 +0,0 @@ -ModuleLoader | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 -

      Methods

      load -

      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.

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

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_application_control_filepicker.FVTTFilePickerControl.html b/docs/classes/_standard_application_control_filepicker.FVTTFilePickerControl.html index f2c17f2..aeaddb7 100644 --- a/docs/classes/_standard_application_control_filepicker.FVTTFilePickerControl.html +++ b/docs/classes/_standard_application_control_filepicker.FVTTFilePickerControl.html @@ -1,5 +1,5 @@ -FVTTFilePickerControl | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -13,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/filepicker/button:

      -

      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 -

      Accessors

      canBrowse -

      Methods

      bringToTop +

      Accessors

      canBrowse +

      Methods

      bringToTop browse close -

      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.

        +

      Constructors

      constructor

      Accessors

      StaticcanBrowse

      • get canBrowse(): boolean

      • Returns boolean

        Test if the current user can browse files.

        +

      Methods

      StaticbringToTop

      • bringToTop(id?: string): 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.

        -

      Staticbrowse

      • browse(options?, event?): Promise<string>

      • Creates a new Foundry FilePicker app to browse and return a file path selection.

        +

      Staticbrowse

      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 +

      Staticclose

      • close(id?: string | Iterable<string, any, any>): 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

        • Optionalid: string | Iterable<string, any, any>

          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 +

      Parameters

      • Optionalid: string | Iterable<string, any, any>

        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_control_sidebar.FVTTSidebarControl.html b/docs/classes/_standard_application_control_sidebar.FVTTSidebarControl.html index a309abf..10df51d 100644 --- a/docs/classes/_standard_application_control_sidebar.FVTTSidebarControl.html +++ b/docs/classes/_standard_application_control_sidebar.FVTTSidebarControl.html @@ -1,5 +1,5 @@ -FVTTSidebarControl | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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 @@ -48,7 +48,7 @@

      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.
            }
         });
      });
+

      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 @@ -57,17 +57,17 @@ remove replace wait -

      Constructors

      constructor

      Methods

      Staticadd

      • add(sidebarData): void

      • Adds a new Svelte powered sidebar tab / panel.

        +

      Constructors

      constructor

      Methods

      Staticadd

      • add(sidebarData: FVTTSidebarAddData): void

      • Adds a new Svelte powered sidebar tab / panel.

        Parameters

        Returns void

      Staticget

      Returns void

      Staticget

      • get(id: string): 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.

        -

      Staticremove

      • remove(sidebarData): void

      • Removes an existing sidebar tab / panel.

        +

      Staticremove

      Staticreplace

      • replace(sidebarData): void

      • Replaces an existing sidebar tab / panel with a new Svelte powered sidebar.

        +

      Returns void

      Staticreplace

      • replace(sidebarData: FVTTSidebarReplaceData): 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

      Staticwait

      • wait(): Promise<any>

      • Provides a Promise that is resolved after all added sidebars are initialized. This is useful when additional +

      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

      On This Page

      Constructors
      Methods
      \ 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_dialog_document.TJSDocumentCreate.html b/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html index 690dfa0..b4e7638 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentCreate.html @@ -1,5 +1,5 @@ -TJSDocumentCreate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSDocumentCreate

      Provides a dialog for creating documents that by default is modal and not draggable.

      +TJSDocumentCreate | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class TJSDocumentCreate

      Provides a dialog for creating documents that by default is modal and not draggable.

      @@ -8,122 +8,133 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm 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: object,
            data?: object,
            context?: {
                options?: Partial<any>;
                pack?: object;
                parent?: object;
                renderSheet?: boolean;
            },
            dialogData?: any,
        ): 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.

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

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

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

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

      Returns TJSDocumentCreate

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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 +

      Staticshow

      • show(
            documentCls: object,
            data?: object,
            context?: {
                options?: any;
                pack?: object;
                parent?: object;
                renderSheet?: boolean;
            },
            dialogData?: any,
        ): 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.

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

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

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

        -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 547adac..4c3fc3b 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentDelete.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentDelete.html @@ -1,5 +1,5 @@ -TJSDocumentDelete | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,112 +10,123 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm prompt show wait -

      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.

            +

      Constructors

      constructor

      • new TJSDocumentDelete(
            document: object,
            opts?: { context?: object; options?: any },
            dialogData?: any,
        ): 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

      Returns TJSDocumentDelete

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      Staticshow

      • show(
            document: object,
            opts?: { context?: object; options?: any },
            dialogData?: any,
        ): Promise<boolean | object>

      • Shows a modal / non-draggable dialog to delete a document.

        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 +

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

      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.

      -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 b07ed30..95627f8 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentDialog.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentDialog.html @@ -1,97 +1,97 @@ -TJSDocumentDialog | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 -

      Methods

      configureOwnership -documentCreate -documentDelete -folderCreate -folderDelete -folderExport -folderRemove -folderRolltable -folderUpdate -importFromJSON -

      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.

        +

      Methods

      configureOwnership +documentCreate +documentDelete +folderCreate +folderDelete +folderExport +folderRemove +folderRolltable +folderUpdate +importFromJSON +

      Constructors

      constructor

      Methods

      StaticconfigureOwnership

      • configureOwnership(
            document: object,
            options?: any,
            dialogData?: any,
        ): 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.

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

        -

      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 +

      StaticdocumentCreate

      • documentCreate(
            documentCls: object,
            data?: object,
            context?: {
                options?: any;
                pack?: object;
                parent?: object;
                renderSheet?: boolean;
            },
            dialogData?: any,
        ): 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.

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

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

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

        -

      StaticdocumentDelete

      • documentDelete(document, opts?, dialogData?): Promise<boolean | object>

      • Shows a modal / non-draggable dialog to delete a document.

        +

      StaticdocumentDelete

      • documentDelete(
            document: object,
            opts?: { context?: object; options?: any },
            dialogData?: any,
        ): Promise<boolean | object>

      • Shows a modal / non-draggable dialog to delete a document.

        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 +

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

      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.

      -

      StaticfolderCreate

      • folderCreate(folderData, options?, dialogData?): Promise<object>

      • Create a new Folder by rendering a dialog window to provide basic creation details.

        +

      StaticfolderCreate

      • folderCreate(
            folderData: object,
            options?: any,
            dialogData?: any,
        ): 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.

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

        -

      StaticfolderDelete

      • folderDelete(document, options?, dialogData?): Promise<boolean | object>

      • Deletes a folder and does delete subfolders / documents.

        +

      StaticfolderDelete

      • folderDelete(
            document: object,
            options?: any,
            dialogData?: any,
        ): Promise<boolean | object>

      • Deletes a folder and does delete subfolders / documents.

        Parameters

        • document: object

          Folder to delete.

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

      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.

      -

      StaticfolderExport

      • folderExport(document, opts?, dialogData?): Promise<boolean | object>

      • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

        +

      StaticfolderExport

      • folderExport(
            document: object,
            opts?: { keepId?: boolean; merge?: boolean; options?: any; pack?: string },
            dialogData?: any,
        ): Promise<boolean | object>

      • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

        Parameters

        • document: object

          Folder to export.

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

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

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

      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.

      -

      StaticfolderRemove

      • folderRemove(document, options?, dialogData?): Promise<boolean | object>

      • Removes a folder, but does not delete / remove sub-folders / documents.

        +

      StaticfolderRemove

      • folderRemove(
            document: object,
            options?: any,
            dialogData?: any,
        ): Promise<boolean | object>

      • Removes a folder, but does not delete / remove sub-folders / documents.

        Parameters

        • document: object

          Folder to remove.

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

      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.

      -

      StaticfolderRolltable

      • folderRolltable(document, options?, dialogData?): Promise<boolean | object>

      • Create a RollTable from the contents of the Folder.

        +

      StaticfolderRolltable

      • folderRolltable(
            document: object,
            options?: any,
            dialogData?: any,
        ): Promise<boolean | object>

      • Create a RollTable from the contents of the Folder.

        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 Promise<boolean | object>

        The newly created RollTable or a falsy value; either +

      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.

      -

      StaticfolderUpdate

      • folderUpdate(document, options?, dialogData?): Promise<object>

      • Updates an existing Folder by rendering a dialog window with basic details.

        +

      StaticfolderUpdate

      • folderUpdate(document: object, options?: any, dialogData?: any): Promise<object>

      • Updates an existing Folder by rendering a dialog window with basic details.

        Parameters

        • document: object

          The folder to edit.

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

        -

      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

        +

      StaticimportFromJSON

      • importFromJSON(
            document: object,
            options?: any,
            dialogData?: any,
        ): 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...

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

      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

      On This Page

      Constructors
      Methods
      \ 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_dialog_document.TJSDocumentImport.html b/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html index 1ce3721..14cbffd 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentImport.html @@ -1,5 +1,5 @@ -TJSDocumentImport | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,111 +10,122 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm 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: object,
            options?: any,
            dialogData?: any,
        ): 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...

        • Optionaloptions: any

          Options to pass to TJSDialog / Application.

        • OptionaldialogData: any

          Optional data to modify dialog.

          -

        Returns TJSDocumentImport

      Accessors

      data

      Returns TJSDocumentImport

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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

        +

      Staticshow

      • show(
            document: object,
            options?: any,
            dialogData?: any,
        ): 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...

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

      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.

      -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 9c6819c..6a31010 100644 --- a/docs/classes/_standard_application_dialog_document.TJSDocumentOwnership.html +++ b/docs/classes/_standard_application_dialog_document.TJSDocumentOwnership.html @@ -1,5 +1,5 @@ -TJSDocumentOwnership | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,109 +10,120 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm prompt show wait -

      Constructors

      constructor

      • new TJSDocumentOwnership(document, options?, dialogData?): TJSDocumentOwnership

      • Parameters

        • document: object

          Document instance to modify.

          +

      Constructors

      constructor

      • new TJSDocumentOwnership(
            document: object,
            options?: any,
            dialogData?: any,
        ): 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

      Returns TJSDocumentOwnership

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      Staticshow

      • show(document: object, options?: any, dialogData?: any): 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.

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

        -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 ffd1994..741125d 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderCreateUpdate.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderCreateUpdate.html @@ -1,5 +1,5 @@ -TJSFolderCreateUpdate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,113 +10,124 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm prompt -showCreate -showUpdate +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: object,
            options?: object,
            dialogData?: any,
        ): TJSFolderCreateUpdate

      • Updates an existing Folder by rendering a dialog window with basic details.

        Parameters

        • document: object

          The folder to edit.

        • Optionaloptions: object

          Options to pass to TJSDialog / Application.

        • OptionaldialogData: any

          Optional data to modify dialog.

          -

        Returns TJSFolderCreateUpdate

      Accessors

      data

      Returns TJSFolderCreateUpdate

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      StaticshowCreate

      • showCreate(
            folderData: object,
            options?: object,
            dialogData?: object,
        ): 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.

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

        -

      StaticshowUpdate

      • showUpdate(document, options?, dialogData?): Promise<object>

      • Updates an existing Folder by rendering a dialog window with basic details.

        +

      StaticshowUpdate

      • showUpdate(
            document: object,
            options?: object,
            dialogData?: any,
        ): Promise<object>

      • Updates an existing Folder by rendering a dialog window with basic details.

        Parameters

        • document: object

          The folder to edit.

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

        -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 50106b2..fe513bc 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderDelete.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderDelete.html @@ -1,5 +1,5 @@ -TJSFolderDelete | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,110 +10,121 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm 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: object,
            options?: any,
            dialogData?: any,
        ): TJSFolderDelete

      • Deletes a folder and does delete sub-folders / documents.

        Parameters

        • document: object

          Folder to delete.

        • Optionaloptions: any

          Options to pass to TJSDialog / Application.

        • OptionaldialogData: any

          Optional data to modify dialog.

          -

        Returns TJSFolderDelete

      Accessors

      data

      Returns TJSFolderDelete

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      Staticshow

      • show(
            document: object,
            options?: any,
            dialogData?: any,
        ): Promise<boolean | object>

      • Deletes a folder and does delete sub-folders / documents.

        Parameters

        • document: object

          Folder to delete.

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

      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.

      -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 89a2736..bad491a 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderExport.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderExport.html @@ -1,5 +1,5 @@ -TJSFolderExport | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSFolderExport

      Provides a reactive dialog for exporting folders to a compendium that by default is modal and not draggable.

      +TJSFolderExport | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class TJSFolderExport

      Provides a reactive dialog for exporting folders to a compendium that by default is modal and not draggable.

      @@ -8,122 +8,133 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm 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: object,
            opts?: { keepId?: boolean; merge?: boolean; options?: any; pack?: string },
            dialogData?: any,
        ): TJSFolderExport

      • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

        Parameters

        • document: object

          Folder to export.

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

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

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

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      Staticshow

      • show(
            document: object,
            opts?: { keepId?: boolean; merge?: boolean; options?: any; pack?: string },
            dialogData?: any,
        ): Promise<boolean | object>

      • Shows a modal / non-draggable dialog to export a folder to an eligible compendium pack.

        Parameters

        • document: object

          Folder to export.

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

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

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

      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.

      -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 8375dea..63938b3 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderRemove.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderRemove.html @@ -1,5 +1,5 @@ -TJSFolderRemove | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,109 +10,120 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm prompt show wait -

      Constructors

      constructor

      • new TJSFolderRemove(document, options?, dialogData?): TJSFolderRemove

      • Parameters

        • document: object

          Folder to remove.

          +

      Constructors

      constructor

      • new TJSFolderRemove(
            document: object,
            options?: any,
            dialogData?: any,
        ): 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

      Returns TJSFolderRemove

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      Staticshow

      • show(
            document: object,
            options?: any,
            dialogData?: any,
        ): Promise<boolean | object>

      • Removes a folder, but does not delete / remove subfolders / documents.

        Parameters

        • document: object

          Folder to remove.

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

      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.

      -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      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 dc7f0a6..1a4cc7d 100644 --- a/docs/classes/_standard_application_dialog_document.TJSFolderRolltable.html +++ b/docs/classes/_standard_application_dialog_document.TJSFolderRolltable.html @@ -1,5 +1,5 @@ -TJSFolderRolltable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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.

      @@ -10,109 +10,120 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      data -elementContent -elementTarget -managedPromise +elementContent +elementTarget +managedPromise position reactive state svelte

      Methods

      maximize minimize -onSvelteMount -onSvelteRemount +onSvelteMount +onSvelteRemount wait confirm prompt show wait -

      Constructors

      constructor

      • new TJSFolderRolltable(document, options?, dialogData?): TJSFolderRolltable

      • Parameters

        • document: object

          Folder to create roll table from...

          +

      Constructors

      constructor

      • new TJSFolderRolltable(
            document: object,
            options?: any,
            dialogData?: any,
        ): 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

      Returns TJSFolderRolltable

      Accessors

      data

      elementContent

      • get elementContent(): HTMLElement

      • Returns the content element if an application shell is mounted.

        +

      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.

        +

      elementTarget

      • get elementTarget(): HTMLElement

      • Returns the target element or main element if no target defined.

        Returns HTMLElement

        Target element.

        -

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        +

      managedPromise

      position

      • get position(): TJSPosition

      • Returns the TJSPosition instance.

        Returns TJSPosition

        The TJSPosition instance.

        -

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        +

      reactive

      • get reactive(): SvelteReactive

      • Returns the reactive accessors & Svelte stores for SvelteApplication.

        Returns SvelteReactive

        The reactive accessors & Svelte stores.

        -

      state

      • get state(): ApplicationState

      • Returns the application state manager.

        +

      state

      svelte

      • get svelte(): GetSvelteData

      • Returns the Svelte helper class w/ various methods to access mounted Svelte components.

        +

      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?: { animate?: boolean; duration?: number }): 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

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

        +

        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?: { animate?: boolean; duration?: number }): 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

        • 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

        • 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

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?): void

      • Provides a callback after the main application shell is remounted. This may occur during HMR / hot module +

      Returns void

      onSvelteRemount

      • onSvelteRemount(mountedAppShell?: 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

        Returns void

      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 +

      Returns void

      wait

      • wait<T>(options?: { reuse?: boolean }): 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

        • Optionaloptions: {
              reuse?: boolean;
          }

          Options.

          -
          • Optionalreuse?: boolean

            When true if there is an existing managed Promise this allows multiple +

            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.

            -

      Staticconfirm

      • confirm<T>(data?, options?): Promise<T>

      • A helper factory method to create simple confirmation dialog windows which consist of simple yes / no prompts. +

      Returns Promise<T>

      A promise for dialog resolution.

      +

      Staticconfirm

      • confirm<T>(
            data?: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • 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

        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 +

          Type Parameters

          • T

          Parameters

          • Optionaldata: TJSDialogOptions & {
                onNo?: string | (data?: { application?: TJSDialog }) => any;
                onYes?: string | (data?: { application?: TJSDialog }) => any;
            }

            Confirm dialog options.

            +
            • OptionalonNo?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon no; may be an +async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
            • OptionalonYes?: string | (data?: { application?: TJSDialog }) => any

              Callback function upon yes; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

              +
          • Optionaloptions: SvelteApplicationOptions

            SvelteApplication options passed to the TJSDialog constructor.

            -

          Returns Promise<T>

          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);
+

        Returns Promise<T>

        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);
        -

      Staticprompt

      • prompt<T>(data?, options?): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        -

        Type Parameters

        • T

        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 +

      Staticprompt

      • prompt<T>(
            data?: TJSDialogOptions & {
                icon?: string;
                label?: string;
                onOk?: string | (data?: { application?: TJSDialog }) => any;
            },
            options?: SvelteApplicationOptions,
        ): Promise<T>

      • A helper factory method to display a basic "prompt" style TJSDialog with a single button.

        +

        Type Parameters

        • T

        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:

          +
          • Optionalicon?: string

            Set another icon besides fas fa-check for button.

            +
          • Optionallabel?: string

            The OK prompt button text.

            +
          • OptionalonOk?: string | (data?: { application?: TJSDialog }) => any

            Callback function upon ok; may be +an async function. When defined as a string any matching function by name exported from content Svelte +component is invoked.

            +
        • Optionaloptions: SvelteApplicationOptions

          SvelteApplication options passed to the TJSDialog constructor.

          -

        Returns Promise<T>

        The returned value from the provided callback function or true if the button +

      Returns Promise<T>

      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);
+
      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.

        +

      Staticshow

      • show(
            document: object,
            options?: any,
            dialogData?: any,
        ): Promise<boolean | object>

      • Create a RollTable from the contents of the Folder.

        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 Promise<boolean | object>

        The newly created RollTable or a falsy value; either +

      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.

      -

      Staticwait

      • wait<T>(data, options?): Promise<T>

      • Creates an anonymous data defined TJSDialog returning a Promise that can be awaited upon for the user to make a +

      Staticwait

      • wait<T>(data: TJSDialogOptions, options?: SvelteApplicationOptions): Promise<T>

      • 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

        Parameters

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns Promise<T>

      A Promise that resolves to the chosen result.

      +

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_application_menu.TJSContextMenu.html b/docs/classes/_standard_application_menu.TJSContextMenu.html index ba377f8..b0b680b 100644 --- a/docs/classes/_standard_application_menu.TJSContextMenu.html +++ b/docs/classes/_standard_application_menu.TJSContextMenu.html @@ -1,5 +1,5 @@ -TJSContextMenu | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 @@ -8,30 +8,30 @@ to the original source after the modal dialog is closed.

      Constructors

      constructor

      Methods

      create -

      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 +

      Constructors

      constructor

      Methods

      Staticcreate

      • create(
            opts?: {
                activeWindow?: Window;
                duration?: number;
                easing?: EasingReference;
                event?: MouseEvent | KeyboardEvent;
                focusDebug?: boolean;
                focusEl?: string | HTMLElement;
                id?: string;
                items?: Iterable<TJSContextMenuItemData, any, any>;
                keyCode?: string;
                offsetX?: number;
                offsetY?: number;
                styles?: { [key: string]: string };
                x?: number;
                y?: number;
                zIndex?: number;
            },
        ): 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

        • Optionalopts: {
              activeWindow?: Window;
              duration?: number;
              easing?: EasingReference;
              event?: MouseEvent | KeyboardEvent;
              focusDebug?: boolean;
              focusEl?: string | HTMLElement;
              id?: string;
              items?: Iterable<TJSContextMenuItemData, any, any>;
              keyCode?: string;
              offsetX?: number;
              offsetY?: number;
              styles?: {
                  [key: string]: string | null;
              };
              x?: number;
              y?: number;
              zIndex?: number;
          }

          Optional parameters.

          -
          • OptionalactiveWindow?: Window

            The active browser window that the context menu is +

            Parameters

            • Optionalopts: {
                  activeWindow?: Window;
                  duration?: number;
                  easing?: EasingReference;
                  event?: MouseEvent | KeyboardEvent;
                  focusDebug?: boolean;
                  focusEl?: string | HTMLElement;
                  id?: string;
                  items?: Iterable<TJSContextMenuItemData, any, any>;
                  keyCode?: string;
                  offsetX?: number;
                  offsetY?: number;
                  styles?: { [key: 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 +

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

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

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

                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 +

              • Optionalid?: string

                A custom CSS ID to add to the menu. This allows CSS style targeting.

                +
              • Optionalitems?: Iterable<TJSContextMenuItemData, any, any>

                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 +

              • OptionaloffsetY?: number

                Small positive integer offset for context menu so the pointer / mouse is over the menu on display.

                -
              • Optionalstyles?: {
                    [key: string]: string | null;
                }

                Optional inline styles to apply.

                -
                • [key: string]: string | null
              • 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 +
    • Optionalstyles?: { [key: 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_component_button.TJSIconButton.html b/docs/classes/_standard_component_button.TJSIconButton.html index b72bab1..9494de9 100644 --- a/docs/classes/_standard_component_button.TJSIconButton.html +++ b/docs/classes/_standard_component_button.TJSIconButton.html @@ -1,5 +1,5 @@ -TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      
+
      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
 
      
 
 
      
@@ -10,10 +10,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_button.TJSSlotButton.html b/docs/classes/_standard_component_button.TJSSlotButton.html index c7d571e..a564c0d 100644 --- a/docs/classes/_standard_component_button.TJSSlotButton.html +++ b/docs/classes/_standard_component_button.TJSSlotButton.html @@ -1,5 +1,5 @@ -TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      
+
      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
 
      
 
 
      
@@ -10,10 +10,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables:
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_button.TJSToggleIconButton.html b/docs/classes/_standard_component_button.TJSToggleIconButton.html index 96087c6..d467c57 100644 --- a/docs/classes/_standard_component_button.TJSToggleIconButton.html +++ b/docs/classes/_standard_component_button.TJSToggleIconButton.html @@ -1,5 +1,5 @@ -TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      
+
      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
 
      
 
 
      
@@ -10,10 +10,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_color_picker_colord.TJSColordButton.html b/docs/classes/_standard_component_color_picker_colord.TJSColordButton.html deleted file mode 100644 index 804a01a..0000000 --- a/docs/classes/_standard_component_color_picker_colord.TJSColordButton.html +++ /dev/null @@ -1,19 +0,0 @@ -TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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-filter-disabled
      --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
      -       -
      -
      -
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      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_color_picker_colord.TJSColordPicker.html b/docs/classes/_standard_component_color_picker_colord.TJSColordPicker.html deleted file mode 100644 index 4ff64c6..0000000 --- a/docs/classes/_standard_component_color_picker_colord.TJSColordPicker.html +++ /dev/null @@ -1,21 +0,0 @@ -TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSColordPicker

      TODO: Finish documentation.

      -

      Events:

      -
        -
      • color: current color
        • -
      -
      -
      - -
      - - Hierarchy
      -       -
      -
      -
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      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_color_picker_colord.TJSColordPickerSavedColors.html b/docs/classes/_standard_component_color_picker_colord.TJSColordPickerSavedColors.html deleted file mode 100644 index ef0aa32..0000000 --- a/docs/classes/_standard_component_color_picker_colord.TJSColordPickerSavedColors.html +++ /dev/null @@ -1,18 +0,0 @@ -TJSColordPickerSavedColors | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 -

      Accessors

      folderData -savedColorsState -id -

      Methods

      destroy -

      Constructors

      constructor

      • new TJSColordPickerSavedColors(opts?): TJSColordPickerSavedColors

      • Parameters

        • Optionalopts: {
              internalState: InternalState;
              label: string;
          }

          Options.

          -
          • internalState: InternalState

            Internal picker state.

            -
          • label: string

            Label for folder.

            -

        Returns TJSColordPickerSavedColors

      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.

        -

      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_container.TJSScrollContainer.html b/docs/classes/_standard_component_container.TJSScrollContainer.html index f211e67..1362f29 100644 --- a/docs/classes/_standard_component_container.TJSScrollContainer.html +++ b/docs/classes/_standard_component_container.TJSScrollContainer.html @@ -1,5 +1,5 @@ -TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSScrollContainer

      Provides a convenient scrollable container / DIV that always allows keyboard scroll navigation by stopping +TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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 @@ -12,10 +12,10 @@

      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_dom_focus.TJSFocusWrap.html b/docs/classes/_standard_component_dom_focus.TJSFocusWrap.html index 832ce21..bf104b5 100644 --- a/docs/classes/_standard_component_dom_focus.TJSFocusWrap.html +++ b/docs/classes/_standard_component_dom_focus.TJSFocusWrap.html @@ -1,5 +1,5 @@ -TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSFocusWrap

      Provides a component to wrap focus to the first focusable element in the given elementRoot prop. Place this +TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Class TJSFocusWrap

      Provides a component to wrap focus to the first focusable element in the given elementRoot prop. Place this component as the last child in elementRoot.

      @@ -9,10 +9,10 @@
      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_folder.TJSIconFolder.html b/docs/classes/_standard_component_folder.TJSIconFolder.html index 4a193a8..acaf506 100644 --- a/docs/classes/_standard_component_folder.TJSIconFolder.html +++ b/docs/classes/_standard_component_folder.TJSIconFolder.html @@ -1,11 +1,11 @@ -TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSIconFolder

      TJSFolder provides a collapsible folder using the details and summary HTMLElements.

      +TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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.
          • @@ -26,7 +26,7 @@
        -

        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:

        @@ -61,7 +61,7 @@ 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:

        +

        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 (disabled):
        --tjs-folder-summary-disabled-color: inherit
        --tjs-folder-summary-disabled-cursor: default

        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`.
        @@ -73,10 +73,10 @@
        Hierarchy
        -
        +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      Exported propsEventsCSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_folder.TJSSvgFolder.html b/docs/classes/_standard_component_folder.TJSSvgFolder.html index 571e518..cbb3cc6 100644 --- a/docs/classes/_standard_component_folder.TJSSvgFolder.html +++ b/docs/classes/_standard_component_folder.TJSSvgFolder.html @@ -1,11 +1,11 @@ -TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSSvgFolder

      TJSFolder provides a collapsible folder using the details and summary HTMLElements.

      +TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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.
          • @@ -18,7 +18,7 @@

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

          @@ -53,7 +53,7 @@ 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:

          +

          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 (disabled):
          --tjs-folder-summary-disabled-color: inherit
          --tjs-folder-summary-disabled-cursor: default

          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`.
          @@ -65,10 +65,10 @@
          Hierarchy
          -
          +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      Exported propsEventsCSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSButton.html b/docs/classes/_standard_component_form.TJSButton.html index 5ff10dc..6bf650c 100644 --- a/docs/classes/_standard_component_form.TJSButton.html +++ b/docs/classes/_standard_component_form.TJSButton.html @@ -1,5 +1,5 @@ -TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSButton

      TODO: Add description

      +TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class TJSButton

      TODO: Add description

      @@ -8,10 +8,10 @@
      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSInput.html b/docs/classes/_standard_component_form.TJSInput.html index 6a8b767..9db8bd0 100644 --- a/docs/classes/_standard_component_form.TJSInput.html +++ b/docs/classes/_standard_component_form.TJSInput.html @@ -1,5 +1,5 @@ -TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 @@ -8,7 +8,7 @@ 

      - `button`: A standard button.
      - `checkbox`: A checkbox input.
      - `number`: A number input.
      - `range`: A range input.
      - `range-number`: A range + number input.
      - `select`: A select input.

      The following types are forwarded onto a standard text input: `email`, `password`, `search`, `text`, `url`.
      -

      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
      @@ -20,10 +20,10 @@
      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

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSInputCheckbox.html b/docs/classes/_standard_component_form.TJSInputCheckbox.html index 2f9633c..5baccb6 100644 --- a/docs/classes/_standard_component_form.TJSInputCheckbox.html +++ b/docs/classes/_standard_component_form.TJSInputCheckbox.html @@ -1,6 +1,6 @@ -TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      
+
      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
 
      
 
 
      
@@ -11,10 +11,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables:
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSInputNumber.html b/docs/classes/_standard_component_form.TJSInputNumber.html index 93ba6ff..25d982d 100644 --- a/docs/classes/_standard_component_form.TJSInputNumber.html +++ b/docs/classes/_standard_component_form.TJSInputNumber.html @@ -1,6 +1,6 @@ -TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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-appearance
      --tjs-input-number-webkit-inner-spin-button-opacity
      --tjs-input-number-webkit-outer-spin-button-appearance
      --tjs-input-number-webkit-outer-spin-button-opacity
+TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0
      
+
      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-appearance
      --tjs-input-number-webkit-inner-spin-button-opacity
      --tjs-input-number-webkit-outer-spin-button-appearance
      --tjs-input-number-webkit-outer-spin-button-opacity
 
      
 
 
      
@@ -11,10 +11,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables:
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSInputRange.html b/docs/classes/_standard_component_form.TJSInputRange.html index fb8c84d..1e16715 100644 --- a/docs/classes/_standard_component_form.TJSInputRange.html +++ b/docs/classes/_standard_component_form.TJSInputRange.html @@ -1,5 +1,5 @@ -TJSInputRange | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSInputRange

      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-range-align
      --tjs-input-transition-focus-visible
      --tjs-input-value-invalid-color
      --tjs-input-width

      --tjs-input-range-appearance
      --tjs-input-range-background
      --tjs-input-range-border
      --tjs-input-range-border-radius
      --tjs-input-range-border-disabled
      --tjs-input-range-box-shadow-focus
      --tjs-input-range-box-shadow-focus-visible
      --tjs-input-range-caret-color
      --tjs-input-range-color
      --tjs-input-range-color-disabled
      --tjs-input-range-cursor
      --tjs-input-range-cursor-disabled
      --tjs-input-range-flex
      --tjs-input-range-font-family
      --tjs-input-range-font-size
      --tjs-input-range-height
      --tjs-input-range-line-height
      --tjs-input-range-outline-focus-visible
      --tjs-input-range-outline-offset
      --tjs-input-range-overflow
      --tjs-input-range-padding
      --tjs-input-range-placeholder-color
      --tjs-input-range-slider-track-box-shadow
      --tjs-input-range-slider-track-box-shadow-focus
      --tjs-input-range-text-align
      --tjs-input-range-slider-thumb-box-shadow
      --tjs-input-range-slider-thumb-box-shadow-focus
      --tjs-input-range-transition-focus-visible
      --tjs-input-range-value-invalid-color
      --tjs-input-range-width
+TJSInputRange | TyphonJS Runtime Library (FVTT) 0.2.0
      
+
      Class TJSInputRange
      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-range-align
      --tjs-input-transition-focus-visible
      --tjs-input-value-invalid-color
      --tjs-input-width

      --tjs-input-range-appearance
      --tjs-input-range-background
      --tjs-input-range-border
      --tjs-input-range-border-radius
      --tjs-input-range-border-disabled
      --tjs-input-range-box-shadow-focus
      --tjs-input-range-box-shadow-focus-visible
      --tjs-input-range-caret-color
      --tjs-input-range-color
      --tjs-input-range-color-disabled
      --tjs-input-range-cursor
      --tjs-input-range-cursor-disabled
      --tjs-input-range-flex
      --tjs-input-range-font-family
      --tjs-input-range-font-size
      --tjs-input-range-height
      --tjs-input-range-line-height
      --tjs-input-range-outline-focus-visible
      --tjs-input-range-outline-offset
      --tjs-input-range-overflow
      --tjs-input-range-padding
      --tjs-input-range-placeholder-color
      --tjs-input-range-slider-track-box-shadow
      --tjs-input-range-slider-track-box-shadow-focus
      --tjs-input-range-text-align
      --tjs-input-range-slider-thumb-box-shadow
      --tjs-input-range-slider-thumb-box-shadow-focus
      --tjs-input-range-transition-focus-visible
      --tjs-input-range-value-invalid-color
      --tjs-input-range-width
 
      
 
 
      
@@ -10,10 +10,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables:
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSInputRangeNumber.html b/docs/classes/_standard_component_form.TJSInputRangeNumber.html index 03d18b4..987c72c 100644 --- a/docs/classes/_standard_component_form.TJSInputRangeNumber.html +++ b/docs/classes/_standard_component_form.TJSInputRangeNumber.html @@ -1,5 +1,5 @@ -TJSInputRangeNumber | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSInputRangeNumber

      Provides a combined TJSInputRange / TJSInputNumber component with a single slotted label wrapper. +TJSInputRangeNumber | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Class TJSInputRangeNumber

      Provides a combined TJSInputRange / TJSInputNumber component with a single slotted label wrapper. This is a convenience component enabling easy hook up of a range + number input from the same data source.

      There is no explicit layout defined. The input data is forwarded on to both range / number components with the exception that readonly only applies to the number input.

      @@ -12,10 +12,10 @@
      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_form.TJSInputText.html b/docs/classes/_standard_component_form.TJSInputText.html index 9bdbdef..586e0d0 100644 --- a/docs/classes/_standard_component_form.TJSInputText.html +++ b/docs/classes/_standard_component_form.TJSInputText.html @@ -1,9 +1,9 @@ -TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSInputText

      A generic input type has issues w/ 2-way binding w/ Svelte. +TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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
      @@ -14,10 +14,10 @@
      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables:
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_form.TJSSelect.html b/docs/classes/_standard_component_form.TJSSelect.html index ceb50ea..0ab94a9 100644 --- a/docs/classes/_standard_component_form.TJSSelect.html +++ b/docs/classes/_standard_component_form.TJSSelect.html @@ -1,5 +1,5 @@ -TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      
+
      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
 
      
 
 
      
@@ -10,10 +10,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_fvtt_editor.TJSContentEdit.html b/docs/classes/_standard_component_fvtt_editor.TJSContentEdit.html index f2b512d..2c282cd 100644 --- a/docs/classes/_standard_component_fvtt_editor.TJSContentEdit.html +++ b/docs/classes/_standard_component_fvtt_editor.TJSContentEdit.html @@ -1,7 +1,7 @@ -TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 @@ -17,7 +17,7 @@ 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.

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

        editor:start - Fired when editing is started.

      -

      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:

      `.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
      @@ -49,10 +49,10 @@
      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      PropsEventsCSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_fvtt_editor.TJSProseMirror.html b/docs/classes/_standard_component_fvtt_editor.TJSProseMirror.html index e1e91c2..fac22b7 100644 --- a/docs/classes/_standard_component_fvtt_editor.TJSProseMirror.html +++ b/docs/classes/_standard_component_fvtt_editor.TJSProseMirror.html @@ -1,7 +1,7 @@ -TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 @@ -27,7 +27,7 @@

        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.

        @@ -47,7 +47,7 @@

        editor:start - Fired when editing is started.

      -

      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:

      `.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%
      @@ -59,10 +59,10 @@
      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      PropsEventsCSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_fvtt_editor.TJSTinyMCE.html b/docs/classes/_standard_component_fvtt_editor.TJSTinyMCE.html index 0d76de1..044e15f 100644 --- a/docs/classes/_standard_component_fvtt_editor.TJSTinyMCE.html +++ b/docs/classes/_standard_component_fvtt_editor.TJSTinyMCE.html @@ -1,7 +1,7 @@ -TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 @@ -21,7 +21,7 @@

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

          @@ -41,7 +41,7 @@

          editor:start - Fired when editing is started.

        -

        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:

        `.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%
        @@ -53,10 +53,10 @@
        Hierarchy
        -
        +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      PropsEventsCSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_fvtt_editor.TinyMCEHelper.html b/docs/classes/_standard_component_fvtt_editor.TinyMCEHelper.html index 9c69120..439b64c 100644 --- a/docs/classes/_standard_component_fvtt_editor.TinyMCEHelper.html +++ b/docs/classes/_standard_component_fvtt_editor.TinyMCEHelper.html @@ -1,65 +1,65 @@ -TinyMCEHelper | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TinyMCEHelper

      Provides custom options for TinyMCE.

      +TinyMCEHelper | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class TinyMCEHelper

      Provides custom options for TinyMCE.

      Please see CONFIG.TinyMCE for the default Foundry options.

      Constructors

      constructor -

      Methods

      configBasic -configStandard -configTJS -optionsSingleLine -

      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 +

      Methods

      configBasic +configStandard +configTJS +optionsSingleLine +

      Constructors

      constructor

      Methods

      StaticconfigBasic

      • configBasic(
            opts?: {
                basicFormats?: boolean;
                contentCSS?: string[];
                contentStyle?: string;
                fontFormat?: boolean;
                fontSize?: boolean;
                help?: boolean;
                stripStyleFormat?: boolean;
                styleFormat?: boolean;
                tjsStyles?: boolean;
                toolbar?: boolean;
            },
        ): object

      • Provides a very basic / limited TinyMCE config that limits the ability to apply many styles from the toolbar or with key commands.

        -

        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.

            +

            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

            -

      StaticconfigStandard

      • configStandard(opts?): object

      • Provides the standard TinyMCE configuration options. This is similar to standard core configuration and the +

      StaticconfigStandard

      • configStandard(
            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;
            },
        ): object

      • Provides the standard TinyMCE configuration options. This is similar to standard core configuration and the ProseMirror editor.

        -

        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.

            +

            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

            -

      StaticconfigTJS

      • configTJS(opts?): object

      • Provides the TJS super cool TinyMCE configuration options. These options are selected for increased media +

      StaticconfigTJS

      • configTJS(
            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;
            },
        ): object

      • Provides the TJS super cool TinyMCE configuration options. These options are selected for increased media embedding and styling flexibility.

        -

        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.

            +

            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

            -

      StaticoptionsSingleLine

      • optionsSingleLine(opts?): object

      • Provides a combined mceConfig and other default options to create a single line editor that prevents pasting, +

      StaticoptionsSingleLine

      • optionsSingleLine(
            opts?: { contentCSS?: string[]; contentStyle?: string },
        ): 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

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

            +

            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

      On This Page

      Constructors
      Methods
      \ 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_filepicker_button.TJSFileButton.html b/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileButton.html index e77edc7..b4f4c0d 100644 --- a/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileButton.html +++ b/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileButton.html @@ -1,5 +1,5 @@ -TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSFileButton

      Provides a pre-configured icon button interfacing w/ the Foundry file picker.

      +TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 urlString prop to create a @@ -12,10 +12,10 @@

      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_filepicker_button.TJSFileIconButton.html b/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileIconButton.html index 24b21aa..f398e8f 100644 --- a/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileIconButton.html +++ b/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileIconButton.html @@ -1,5 +1,5 @@ -TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSFileIconButton

      Provides a pre-configured icon button interfacing w/ the Foundry file picker.

      +TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 urlString prop to create a @@ -12,10 +12,10 @@

      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_filepicker_button.TJSFileSlotButton.html b/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.html index 73d9955..ea8eb13 100644 --- a/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.html +++ b/docs/classes/_standard_component_fvtt_filepicker_button.TJSFileSlotButton.html @@ -1,5 +1,5 @@ -TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      Class TJSFileSlotButton

      Provides a pre-configured slotted button interfacing w/ the Foundry file picker. You may assign a child component that obtains the urlString store.

      Please see FVTTFilePickerBrowseOptions for the pickerOptions prop. Please see TJSSlotButton for the button component / CSS variable support.

      @@ -13,10 +13,10 @@
      Hierarchy
      -
      +
      -

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_settings.TJSSettingsEdit.html b/docs/classes/_standard_component_fvtt_settings.TJSSettingsEdit.html index dc69484..eb1997e 100644 --- a/docs/classes/_standard_component_fvtt_settings.TJSSettingsEdit.html +++ b/docs/classes/_standard_component_fvtt_settings.TJSSettingsEdit.html @@ -1,5 +1,5 @@ -TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSSettingsEdit

      TJSSettingsEdit provides the main Svelte component to display and modify settings registered with +TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Class TJSSettingsEdit

      TJSSettingsEdit provides the main Svelte component to display and modify settings registered with TJSGameSettingsWithUI. Refer to the documentation in TJSGameSettings.register and TJSGameSettings.registerAll. Adding custom defined sections is accomplished with TJSGameSettingsWithUI.uiControl.addSection. You must pass an instance of TJSGameSettingsWithUI as the @@ -18,7 +18,7 @@ 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:

      +

      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
      @@ -30,10 +30,10 @@
      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

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        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_fvtt_settings.TJSSettingsSwap.html b/docs/classes/_standard_component_fvtt_settings.TJSSettingsSwap.html index e3922f9..1db8aab 100644 --- a/docs/classes/_standard_component_fvtt_settings.TJSSettingsSwap.html +++ b/docs/classes/_standard_component_fvtt_settings.TJSSettingsSwap.html @@ -1,5 +1,5 @@ -TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSSettingsSwap

      TJSSettingsSwap provides a convenience component to swap a main slotted component with TJSSettingsEdit.

      +TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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.

      @@ -14,10 +14,10 @@
      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_fvtt_settings.TJSThemeEditor.html b/docs/classes/_standard_component_fvtt_settings.TJSThemeEditor.html index b7ae3ce..eb22045 100644 --- a/docs/classes/_standard_component_fvtt_settings.TJSThemeEditor.html +++ b/docs/classes/_standard_component_fvtt_settings.TJSThemeEditor.html @@ -1,5 +1,5 @@ -TJSThemeEditor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSThemeEditor

      TODO: Add description

      +TJSThemeEditor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class TJSThemeEditor

      TODO: Add description

      @@ -8,10 +8,10 @@
      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_label.TJSSlotLabel.html b/docs/classes/_standard_component_label.TJSSlotLabel.html index f361479..81b006b 100644 --- a/docs/classes/_standard_component_label.TJSSlotLabel.html +++ b/docs/classes/_standard_component_label.TJSSlotLabel.html @@ -1,10 +1,10 @@ -TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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
      @@ -16,10 +16,10 @@
      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

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        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_label.TJSSlotLabelUtil.html b/docs/classes/_standard_component_label.TJSSlotLabelUtil.html index 65904d2..ae32071 100644 --- a/docs/classes/_standard_component_label.TJSSlotLabelUtil.html +++ b/docs/classes/_standard_component_label.TJSSlotLabelUtil.html @@ -1,6 +1,6 @@ -TJSSlotLabelUtil | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSSlotLabelUtil

      Provides a helper utility to verify if a label prop is valid for the TJSSlotLabel component.

      +TJSSlotLabelUtil | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      StaticisValid

      • isValid(label): label is string | TJSSvelteConfig

      • Test if the given label is valid data / prop for the TJSSlotLabel component.

        -

        Parameters

        • label: any

        Returns label is string | TJSSvelteConfig

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Methods

      isValid +

      Constructors

      constructor

      Methods

      StaticisValid

      • isValid(label: any): label is string | TJSSvelteConfig

      • Test if the given label is valid data / prop for the TJSSlotLabel component.

        +

        Parameters

        • label: any

        Returns label is string | TJSSvelteConfig

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_label.TJSToggleLabel.html b/docs/classes/_standard_component_label.TJSToggleLabel.html index 753a655..ba281ea 100644 --- a/docs/classes/_standard_component_label.TJSToggleLabel.html +++ b/docs/classes/_standard_component_label.TJSToggleLabel.html @@ -1,5 +1,5 @@ -TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      
+
      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
 
      
 
 
      
@@ -10,10 +10,10 @@ 
      
                   Hierarchy
      
               
               
      
-              
      
+              
      
            
-

      Constructors

      constructor -

      Methods

      $destroy -$on -$set -

      Constructors

      constructor

      Methods

      $destroy

      $on

      $set

      Settings

      Member Visibility

      On This Page

      CSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      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_layer_position.TJSPositionControlLayer.html b/docs/classes/_standard_component_layer_position.TJSPositionControlLayer.html index f3fa77d..f3f6bb3 100644 --- a/docs/classes/_standard_component_layer_position.TJSPositionControlLayer.html +++ b/docs/classes/_standard_component_layer_position.TJSPositionControlLayer.html @@ -1,5 +1,5 @@ -TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSPositionControlLayer

      TODO: Add description

      +TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class TJSPositionControlLayer

      TODO: Add description

      @@ -8,10 +8,10 @@
      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_layer_side_slide.TJSSideSlideLayer.html b/docs/classes/_standard_component_layer_side_slide.TJSSideSlideLayer.html deleted file mode 100644 index 98f8006..0000000 --- a/docs/classes/_standard_component_layer_side_slide.TJSSideSlideLayer.html +++ /dev/null @@ -1,18 +0,0 @@ -TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0
      -

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

      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_media.TJSMediaContent.html b/docs/classes/_standard_component_media.TJSMediaContent.html index 1a2b6ad..19e0d5d 100644 --- a/docs/classes/_standard_component_media.TJSMediaContent.html +++ b/docs/classes/_standard_component_media.TJSMediaContent.html @@ -1,5 +1,5 @@ -TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      Class TJSMediaContent

      Provides an initial implementation to display image or video content from a given file path.

      You can either set the url prop or use TJSFileSlotButton and embed TJSMediaContent as a child. A url context / store will be examined if it exists to obtain a file path to load.

      The following CSS variables control the associated styles with the default values:

      @@ -14,10 +14,10 @@
      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

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_component_menu.TJSMenu.html b/docs/classes/_standard_component_menu.TJSMenu.html index fb4109c..d66869b 100644 --- a/docs/classes/_standard_component_menu.TJSMenu.html +++ b/docs/classes/_standard_component_menu.TJSMenu.html @@ -1,5 +1,5 @@ -TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 @@ -35,7 +35,7 @@

      -

      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 @@ -43,12 +43,12 @@ 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
      @@ -59,10 +59,10 @@
      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

      On This Page

      EventsStylingCSS Variables
      Constructors
      Methods
      \ No newline at end of file +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(
            type: K,
            callback: (e: CustomEvent<any>) => void,
        ): () => void

      • Type Parameters

        • K extends string

        Parameters

        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_fvtt.FVTTVersion.html b/docs/classes/_standard_fvtt.FVTTVersion.html index 4ea1498..3688d12 100644 --- a/docs/classes/_standard_fvtt.FVTTVersion.html +++ b/docs/classes/_standard_fvtt.FVTTVersion.html @@ -1,15 +1,15 @@ -FVTTVersion | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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 -

      Methods

      isAtLeast -isBetween -

      Constructors

      constructor

      Methods

      StaticisAtLeast

      • isAtLeast(version): boolean

      • Returns true when Foundry is at least the specific major version number provided.

        +

      Methods

      isAtLeast +isBetween +

      Constructors

      constructor

      Methods

      StaticisAtLeast

      • isAtLeast(version: number): boolean

      • Returns true when Foundry is at least the specific major version number provided.

        Note: game must be initialized for correct comparison; use after Foundry init hook.

        Parameters

        • version: number

          Major version to check against.

        Returns boolean

        Foundry version is at least the major version specified.

        -

      StaticisBetween

      • isBetween(min, max): boolean

      • Returns true when Foundry is inclusively between the min / max major version numbers provided.

        +

      StaticisBetween

      • isBetween(min: number, max: number): boolean

      • Returns true when Foundry is inclusively 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

      On This Page

      Constructors
      Methods
      \ 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 2c97203..62cc70f 100644 --- a/docs/classes/_standard_fvtt.FontManager.html +++ b/docs/classes/_standard_fvtt.FontManager.html @@ -1,24 +1,24 @@ -FontManager | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class FontManager

      Loads FVTT core fonts supporting FontConfig on Foundry v10+.

      +FontManager | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 -

      Methods

      getCoreDefinitions -loadFonts -removeDuplicateDefinitions -

      Constructors

      constructor

      Methods

      StaticgetCoreDefinitions

      StaticloadFonts

      • loadFonts(opts?): Promise<void>

      • Ensure that fonts have loaded and are ready for use. +

      Methods

      getCoreDefinitions +loadFonts +removeDuplicateDefinitions +

      Constructors

      constructor

      Methods

      StaticgetCoreDefinitions

      • getCoreDefinitions(): { [key: string]: object }[]

      • Collect all the font definitions and combine them.

        +

        Returns { [key: string]: object }[]

        Core font definitions.

        +

      StaticloadFonts

      • loadFonts(
            opts?: {
                document?: Document;
                editor?: boolean;
                fonts?: { [key: string]: object } | { [key: string]: object }[];
                ms?: number;
            },
        ): 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

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

            Parameters

            • Optionalopts: {
                  document?: Document;
                  editor?: boolean;
                  fonts?: { [key: string]: object } | { [key: string]: object }[];
                  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]: object } | { [key: string]: object }[]

                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

      • removeDuplicateDefinitions(fonts): {
            [key: string]: globalThis.FontFamilyDefinition;
        }[]

      • Removes duplicate font definitions.

        -

        Parameters

        • fonts: {
              [key: string]: globalThis.FontFamilyDefinition;
          }[]

          An array of FontFamilyDefinition objects +

        • Optionalms?: number

          The maximum time to spend loading fonts before proceeding.

          +

      Returns Promise<void>

      StaticremoveDuplicateDefinitions

      • removeDuplicateDefinitions(
            fonts: { [key: string]: object }[],
        ): { [key: string]: object }[]

      • Removes duplicate font definitions.

        +

        Parameters

        • fonts: { [key: string]: object }[]

          An array of FontFamilyDefinition objects to process.

          -

        Returns {
            [key: string]: globalThis.FontFamilyDefinition;
        }[]

        Filtered font definitions.

        -

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file +

      Returns { [key: string]: object }[]

      Filtered font definitions.

      +

      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 a2b10cc..8f1d7d2 100644 --- a/docs/classes/_standard_fvtt.FoundryStyles.html +++ b/docs/classes/_standard_fvtt.FoundryStyles.html @@ -1,15 +1,15 @@ -FoundryStyles | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class FoundryStyles

      Parses the core Foundry style sheet creating an indexed object of properties by selector.

      +FoundryStyles | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Class FoundryStyles

      Parses the core Foundry style sheet creating an indexed object of properties by selector.

      Constructors

      constructor -

      Methods

      getProperties -getProperty -

      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 +

      Methods

      getProperties +getProperty +

      Constructors

      constructor

      Methods

      StaticgetProperties

      • getProperties(selector: string): { [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

      StaticgetProperty

      • getProperty(selector, property): string

      • Gets a specific property value from the given selector and property key. Try and use a direct selector +

      Returns { [key: string]: string }

      Properties object.

      +

      StaticgetProperty

      • getProperty(selector: string, property: string): 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

      On This Page

      Constructors
      Methods
      \ 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_store_fvtt_settings.TJSGameSettingsWithUI.html b/docs/classes/_standard_store_fvtt_settings.TJSGameSettingsWithUI.html index f6b65bb..07187fa 100644 --- a/docs/classes/_standard_store_fvtt_settings.TJSGameSettingsWithUI.html +++ b/docs/classes/_standard_store_fvtt_settings.TJSGameSettingsWithUI.html @@ -1,5 +1,5 @@ -TJSGameSettingsWithUI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Class TJSGameSettingsWithUI

      Extends TJSGameSettings with UI control for working with TJSSettingsEdit and TJSSettingsSwap +TJSGameSettingsWithUI | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Class TJSGameSettingsWithUI

      Extends TJSGameSettings with UI control for working with TJSSettingsEdit and TJSSettingsSwap components. Instead of extending TJSGameSettings simply extend TJSGameSettingsWithUI instead when creating reactive game settings that utilize the above components.

      @@ -10,43 +10,43 @@
      Hierarchy
      -
      +

      Constructors

      constructor

      Accessors

      namespace -uiControl +uiControl

      Methods

      data entries -getReadableStore -getStore -getWritableStore +getReadableStore +getStore +getWritableStore keys register -registerAll +registerAll stores -

      Constructors

      constructor

      Constructors

      constructor

      Accessors

      namespace

      • get namespace(): string

      • Returns string

        Returns namespace set in constructor.

        -

      uiControl

      Methods

      data

      Returns TJSGameSettingsWithUI

      Accessors

      namespace

      • get namespace(): string

      • Returns string

        Returns namespace set in constructor.

        +

      uiControl

      Methods

      data

      entries

      entries

      getReadableStore

      • getReadableStore(key): Readable<any>

      • Returns a readable Game Settings store for the associated key.

        +

      Returns IterableIterator<[string, Writable<T>], any, any>

      Iterable iterator of keys and stores.

      +

      Yields

      getReadableStore

      • getReadableStore(key: string): 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

      • getStore(key: string): Writable<any>

      • Returns a writable Game Settings store for the associated key.

        Parameters

        • key: string

          Game setting key.

        Returns Writable<any>

        The associated store for the given game setting key.

        -

      getWritableStore

      getWritableStore

      • getWritableStore(key: string): Writable<any>

      • Returns a writable Game Settings store for the associated key.

        Parameters

        • key: string

          Game setting key.

        Returns Writable<any>

        The associated store for the given game setting key.

        -

      keys

      keys

      • keys(regex?: RegExp): IterableIterator<string, any, any>

      • Returns an iterable for the game setting keys from existing stores.

        Parameters

        • Optionalregex: RegExp

          Optional regular expression to filter by game setting keys.

          -

        Returns IterableIterator<string, any, any>

        Iterable iterator of game setting keys.

        -

        Yields

      register

      • register(setting, coreConfig?): Function

      • Registers a setting with TJSGameSettings and Foundry core.

        +

      Returns IterableIterator<string, any, any>

      Iterable iterator of game setting keys.

      +

      Yields

      register

      • register(setting: GameSetting, coreConfig?: boolean): 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 @@ -58,16 +58,16 @@

        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

      • registerAll(
            settings: Iterable<GameSetting, any, any>,
            coreConfig: boolean,
        ): { [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, any, any>

          An iterable list of game setting configurations to register.

          +

          Parameters

          • settings: Iterable<GameSetting, any, any>

            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.

            -

          Returns {
              [key: string]: Function;
          }

          An object containing all TJSGameSetting store subscriber handlers for each +

      Returns { [key: string]: Function }

      An object containing all TJSGameSetting store subscriber handlers for each setting key added.

      -

      stores

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file +

      Returns IterableIterator<Writable<T>, any, any>

      Iterable iterator of stores.

      +

      Yields

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ No newline at end of file diff --git a/docs/classes/_standard_store_fvtt_settings.TJSThemeStore.html b/docs/classes/_standard_store_fvtt_settings.TJSThemeStore.html index 8e4ba70..0e4ef96 100644 --- a/docs/classes/_standard_store_fvtt_settings.TJSThemeStore.html +++ b/docs/classes/_standard_store_fvtt_settings.TJSThemeStore.html @@ -1,15 +1,15 @@ -TJSThemeStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      Class TJSThemeStore

      Must be constructed from a TJSGameSettings instance init / initialize method called from the ready Foundry VTT hook.

      Constructors

      constructor

      Accessors

      stores

      Methods

      set subscribe -

      Constructors

      constructor

      Accessors

      stores

      • get stores(): {
            [key: string]: Writable<string | null>;
        }

      • Returns {
            [key: string]: Writable<string | null>;
        }

        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: object): TJSThemeStore

      • Sets the theme store with new data.

        Parameters

        • themeData: object

        Returns TJSThemeStore

        This theme store instance.

        -

      subscribe

      • subscribe(handler): Unsubscriber

      • Parameters

        • handler: Subscriber<{
              [key: string]: object;
          }>

          Callback function that is invoked on +

      subscribe

      • subscribe(handler: Subscriber<{ [key: string]: object }>): Unsubscriber

      • Parameters

        • handler: Subscriber<{ [key: string]: object }>

          Callback function that is invoked on update / changes. Receives copy of the theme data.

        Returns Unsubscriber

        Unsubscribe function.

        -

      Settings

      Member Visibility

      On This Page

      Constructors
      Accessors
      Methods
      \ 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/svelte.SvelteComponent.html b/docs/classes/svelte.SvelteComponent.html index ddcaa45..47bd541 100644 --- a/docs/classes/svelte.SvelteComponent.html +++ b/docs/classes/svelte.SvelteComponent.html @@ -1,7 +1,7 @@ -SvelteComponent | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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}> {}
@@ -13,7 +13,7 @@
 
      <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
      +

      Type Parameters

      • Props extends Record<string, any> = any
      • Events extends Record<string, any> = any
      • Slots extends Record<string, any> = any
      @@ -21,10 +21,10 @@
      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: 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 +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(type: K, callback: (e: Events[K]) => void): () => void

      • Type Parameters

        • K extends string

        Parameters

        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 40716ce..8bb7837 100644 --- a/docs/classes/svelte.SvelteComponentTyped.html +++ b/docs/classes/svelte.SvelteComponentTyped.html @@ -1,6 +1,6 @@ -SvelteComponentTyped | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +SvelteComponentTyped | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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
      @@ -8,10 +8,10 @@
      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: 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 +

      Indexable

      • [prop: string]: any

      Constructors

      constructor +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      $on

      • $on<K extends string>(type: K, callback: (e: Events[K]) => void): () => void

      • Type Parameters

        • K extends string

        Parameters

        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 66dccca..4c4d5ce 100644 --- a/docs/classes/svelte.SvelteComponent_1.html +++ b/docs/classes/svelte.SvelteComponent_1.html @@ -1,6 +1,6 @@ -SvelteComponent_1 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +SvelteComponent_1 | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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
      @@ -8,10 +8,10 @@
      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: 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 +

      Methods

      $destroy +$on +$set +

      Constructors

      constructor

      Methods

      $destroy

      • $destroy(): void

      • Returns void

      $on

      • $on<K extends string>(type: K, callback: (e: Events[K]) => void): () => void

      • Type Parameters

        • K extends string

        Parameters

        Returns () => void

      $set

      Settings

      Member Visibility

      On This Page

      Constructors
      Methods
      \ No newline at end of file diff --git a/docs/enums/_runtime_data_format_jsonc.ParseErrorCode.html b/docs/enums/_runtime_data_format_jsonc.ParseErrorCode.html index df877a9..22e893f 100644 --- a/docs/enums/_runtime_data_format_jsonc.ParseErrorCode.html +++ b/docs/enums/_runtime_data_format_jsonc.ParseErrorCode.html @@ -1,18 +1,18 @@ -ParseErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Enumeration ParseErrorCodeConst

      Enumeration Members

      CloseBraceExpected -CloseBracketExpected -ColonExpected -CommaExpected -EndOfFileExpected -InvalidCharacter -InvalidCommentToken -InvalidEscapeCharacter -InvalidNumberFormat -InvalidSymbol -InvalidUnicode -PropertyNameExpected -UnexpectedEndOfComment -UnexpectedEndOfNumber -UnexpectedEndOfString -ValueExpected -

      Enumeration Members

      CloseBraceExpected

      CloseBraceExpected

      CloseBracketExpected

      CloseBracketExpected

      ColonExpected

      ColonExpected

      CommaExpected

      CommaExpected

      EndOfFileExpected

      EndOfFileExpected

      InvalidCharacter

      InvalidCharacter

      InvalidCommentToken

      InvalidCommentToken

      InvalidEscapeCharacter

      InvalidEscapeCharacter

      InvalidNumberFormat

      InvalidNumberFormat

      InvalidSymbol

      InvalidSymbol

      InvalidUnicode

      InvalidUnicode

      PropertyNameExpected

      PropertyNameExpected

      UnexpectedEndOfComment

      UnexpectedEndOfComment

      UnexpectedEndOfNumber

      UnexpectedEndOfNumber

      UnexpectedEndOfString

      UnexpectedEndOfString

      ValueExpected

      ValueExpected

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ No newline at end of file +ParseErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Enumeration ParseErrorCodeConst

      Enumeration Members

      CloseBraceExpected +CloseBracketExpected +ColonExpected +CommaExpected +EndOfFileExpected +InvalidCharacter +InvalidCommentToken +InvalidEscapeCharacter +InvalidNumberFormat +InvalidSymbol +InvalidUnicode +PropertyNameExpected +UnexpectedEndOfComment +UnexpectedEndOfNumber +UnexpectedEndOfString +ValueExpected +

      Enumeration Members

      CloseBraceExpected

      CloseBraceExpected: 7

      CloseBracketExpected

      CloseBracketExpected: 8

      ColonExpected

      ColonExpected: 5

      CommaExpected

      CommaExpected: 6

      EndOfFileExpected

      EndOfFileExpected: 9

      InvalidCharacter

      InvalidCharacter: 16

      InvalidCommentToken

      InvalidCommentToken: 10

      InvalidEscapeCharacter

      InvalidEscapeCharacter: 15

      InvalidNumberFormat

      InvalidNumberFormat: 2

      InvalidSymbol

      InvalidSymbol: 1

      InvalidUnicode

      InvalidUnicode: 14

      PropertyNameExpected

      PropertyNameExpected: 3

      UnexpectedEndOfComment

      UnexpectedEndOfComment: 11

      UnexpectedEndOfNumber

      UnexpectedEndOfNumber: 13

      UnexpectedEndOfString

      UnexpectedEndOfString: 12

      ValueExpected

      ValueExpected: 4

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ No newline at end of file diff --git a/docs/enums/_runtime_data_format_jsonc.ScanError.html b/docs/enums/_runtime_data_format_jsonc.ScanError.html index f95520e..b19f624 100644 --- a/docs/enums/_runtime_data_format_jsonc.ScanError.html +++ b/docs/enums/_runtime_data_format_jsonc.ScanError.html @@ -1,9 +1,9 @@ -ScanError | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Enumeration ScanErrorConst

      Enumeration Members

      InvalidCharacter -InvalidEscapeCharacter -InvalidUnicode -None -UnexpectedEndOfComment -UnexpectedEndOfNumber -UnexpectedEndOfString -

      Enumeration Members

      InvalidCharacter

      InvalidCharacter

      InvalidEscapeCharacter

      InvalidEscapeCharacter

      InvalidUnicode

      InvalidUnicode

      None

      None

      UnexpectedEndOfComment

      UnexpectedEndOfComment

      UnexpectedEndOfNumber

      UnexpectedEndOfNumber

      UnexpectedEndOfString

      UnexpectedEndOfString

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ No newline at end of file +ScanError | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Enumeration ScanErrorConst

      Enumeration Members

      InvalidCharacter +InvalidEscapeCharacter +InvalidUnicode +None +UnexpectedEndOfComment +UnexpectedEndOfNumber +UnexpectedEndOfString +

      Enumeration Members

      InvalidCharacter

      InvalidCharacter: 6

      InvalidEscapeCharacter

      InvalidEscapeCharacter: 5

      InvalidUnicode

      InvalidUnicode: 4

      None

      None: 0

      UnexpectedEndOfComment

      UnexpectedEndOfComment: 1

      UnexpectedEndOfNumber

      UnexpectedEndOfNumber: 3

      UnexpectedEndOfString

      UnexpectedEndOfString: 2

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ No newline at end of file diff --git a/docs/enums/_runtime_data_format_jsonc.SyntaxKind.html b/docs/enums/_runtime_data_format_jsonc.SyntaxKind.html index 7978956..c3656c6 100644 --- a/docs/enums/_runtime_data_format_jsonc.SyntaxKind.html +++ b/docs/enums/_runtime_data_format_jsonc.SyntaxKind.html @@ -1,19 +1,19 @@ -SyntaxKind | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Enumeration SyntaxKindConst

      Enumeration Members

      BlockCommentTrivia -CloseBraceToken -CloseBracketToken -ColonToken -CommaToken -EOF -FalseKeyword -LineBreakTrivia -LineCommentTrivia -NullKeyword -NumericLiteral -OpenBraceToken -OpenBracketToken -StringLiteral -Trivia -TrueKeyword -Unknown -

      Enumeration Members

      BlockCommentTrivia

      BlockCommentTrivia

      CloseBraceToken

      CloseBraceToken

      CloseBracketToken

      CloseBracketToken

      ColonToken

      ColonToken

      CommaToken

      CommaToken

      EOF

      EOF

      FalseKeyword

      FalseKeyword

      LineBreakTrivia

      LineBreakTrivia

      LineCommentTrivia

      LineCommentTrivia

      NullKeyword

      NullKeyword

      NumericLiteral

      NumericLiteral

      OpenBraceToken

      OpenBraceToken

      OpenBracketToken

      OpenBracketToken

      StringLiteral

      StringLiteral

      Trivia

      Trivia

      TrueKeyword

      TrueKeyword

      Unknown

      Unknown

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ No newline at end of file +SyntaxKind | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Enumeration SyntaxKindConst

      Enumeration Members

      BlockCommentTrivia +CloseBraceToken +CloseBracketToken +ColonToken +CommaToken +EOF +FalseKeyword +LineBreakTrivia +LineCommentTrivia +NullKeyword +NumericLiteral +OpenBraceToken +OpenBracketToken +StringLiteral +Trivia +TrueKeyword +Unknown +

      Enumeration Members

      BlockCommentTrivia

      BlockCommentTrivia: 13

      CloseBraceToken

      CloseBraceToken: 2

      CloseBracketToken

      CloseBracketToken: 4

      ColonToken

      ColonToken: 6

      CommaToken

      CommaToken: 5

      EOF

      EOF: 17

      FalseKeyword

      FalseKeyword: 9

      LineBreakTrivia

      LineBreakTrivia: 14

      LineCommentTrivia

      LineCommentTrivia: 12

      NullKeyword

      NullKeyword: 7

      NumericLiteral

      NumericLiteral: 11

      OpenBraceToken

      OpenBraceToken: 1

      OpenBracketToken

      OpenBracketToken: 3

      StringLiteral

      StringLiteral: 10

      Trivia

      Trivia: 15

      TrueKeyword

      TrueKeyword: 8

      Unknown

      Unknown: 16

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ 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 c63040e..6028b34 100644 --- a/docs/enums/_runtime_data_format_msgpack.FLOAT32_OPTIONS.html +++ b/docs/enums/_runtime_data_format_msgpack.FLOAT32_OPTIONS.html @@ -1,6 +1,6 @@ -FLOAT32_OPTIONS | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Enumeration FLOAT32_OPTIONS

      Enumeration Members

      ALWAYS -DECIMAL_FIT -DECIMAL_ROUND -NEVER -

      Enumeration Members

      ALWAYS

      ALWAYS

      DECIMAL_FIT

      DECIMAL_FIT

      DECIMAL_ROUND

      DECIMAL_ROUND

      NEVER

      NEVER

      Settings

      Member Visibility

      On This Page

      Enumeration Members
      \ No newline at end of file +FLOAT32_OPTIONS | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      On This Page

      Enumeration Members
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_color_colord.colord-1.html b/docs/functions/_runtime_data_color_colord.colord-1.html index 9bd4403..d77701c 100644 --- a/docs/functions/_runtime_data_color_colord.colord-1.html +++ b/docs/functions/_runtime_data_color_colord.colord-1.html @@ -1,4 +1,4 @@ -colord | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function colord

      Parses the given input color and creates a new Colord instance. +colord | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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 +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_color_colord.extend.html b/docs/functions/_runtime_data_color_colord.extend.html index e08ea13..cbd485a 100644 --- a/docs/functions/_runtime_data_color_colord.extend.html +++ b/docs/functions/_runtime_data_color_colord.extend.html @@ -1,2 +1,2 @@ -extend | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function extend

      • extend(plugins): void

      • Parameters

        Returns void

      Settings

      Member Visibility
      \ No newline at end of file +extend | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function extend

      • extend(plugins: Plugin[]): void

      • Parameters

        Returns void

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_color_colord.getFormat.html b/docs/functions/_runtime_data_color_colord.getFormat.html index 9d8308d..1f8c018 100644 --- a/docs/functions/_runtime_data_color_colord.getFormat.html +++ b/docs/functions/_runtime_data_color_colord.getFormat.html @@ -1,3 +1,3 @@ -getFormat | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +getFormat | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function getFormat

      Returns a color model name for the input passed to the function.

      +
      • getFormat(input: Input): Format

      • Parameters

        • input: Input

        Returns Format

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_color_colord.random.html b/docs/functions/_runtime_data_color_colord.random.html index b29955a..34340e7 100644 --- a/docs/functions/_runtime_data_color_colord.random.html +++ b/docs/functions/_runtime_data_color_colord.random.html @@ -1,2 +1,2 @@ -random | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function random

      Settings

      Member Visibility
      \ No newline at end of file +random | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 c7c9c33..495d6cc 100644 --- a/docs/functions/_runtime_data_compress.compress-1.html +++ b/docs/functions/_runtime_data_compress.compress-1.html @@ -1,11 +1,11 @@ -compress | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 3995ebb..28f1aa9 100644 --- a/docs/functions/_runtime_data_compress.compressSync.html +++ b/docs/functions/_runtime_data_compress.compressSync.html @@ -1,6 +1,6 @@ -compressSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 a7342ca..21e4ae1 100644 --- a/docs/functions/_runtime_data_compress.decompress-1.html +++ b/docs/functions/_runtime_data_compress.decompress-1.html @@ -1,11 +1,11 @@ -decompress | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 5088ff9..8fdf25f 100644 --- a/docs/functions/_runtime_data_compress.decompressSync.html +++ b/docs/functions/_runtime_data_compress.decompressSync.html @@ -1,6 +1,6 @@ -decompressSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 bb42af5..052537c 100644 --- a/docs/functions/_runtime_data_compress.deflate-1.html +++ b/docs/functions/_runtime_data_compress.deflate-1.html @@ -1,10 +1,10 @@ -deflate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function deflate

      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 0bb4d2b..5aa5b55 100644 --- a/docs/functions/_runtime_data_compress.deflateSync.html +++ b/docs/functions/_runtime_data_compress.deflateSync.html @@ -1,6 +1,6 @@ -deflateSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 f394799..cbb24d0 100644 --- a/docs/functions/_runtime_data_compress.gunzip-1.html +++ b/docs/functions/_runtime_data_compress.gunzip-1.html @@ -1,11 +1,11 @@ -gunzip | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 4195b94..624ed59 100644 --- a/docs/functions/_runtime_data_compress.gunzipSync.html +++ b/docs/functions/_runtime_data_compress.gunzipSync.html @@ -1,6 +1,6 @@ -gunzipSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 2aeb917..5c2a3e4 100644 --- a/docs/functions/_runtime_data_compress.inflate-1.html +++ b/docs/functions/_runtime_data_compress.inflate-1.html @@ -1,11 +1,11 @@ -inflate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 5e8b1fe..9ccac7b 100644 --- a/docs/functions/_runtime_data_compress.inflateSync.html +++ b/docs/functions/_runtime_data_compress.inflateSync.html @@ -1,6 +1,6 @@ -inflateSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 5b4bd97..b4fd7c3 100644 --- a/docs/functions/_runtime_data_compress.strFromU8.html +++ b/docs/functions/_runtime_data_compress.strFromU8.html @@ -1,7 +1,7 @@ -strFromU8 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function strFromU8

      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 e482ef0..eb9c627 100644 --- a/docs/functions/_runtime_data_compress.strToU8.html +++ b/docs/functions/_runtime_data_compress.strToU8.html @@ -1,7 +1,7 @@ -strToU8 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function strToU8

        • strToU8(str: string, latin1?: boolean): Uint8Array

        • Converts a string into a Uint8Array for use with compression/decompression methods

          Parameters

          • str: string

            The string to encode

          • 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
        \ 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 5839506..3bdd3e6 100644 --- a/docs/functions/_runtime_data_compress.unzip-1.html +++ b/docs/functions/_runtime_data_compress.unzip-1.html @@ -1,11 +1,11 @@ -unzip | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 0af6dcc..dfd9e6f 100644 --- a/docs/functions/_runtime_data_compress.unzipSync.html +++ b/docs/functions/_runtime_data_compress.unzipSync.html @@ -1,7 +1,7 @@ -unzipSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 ff5cce5..2a144da 100644 --- a/docs/functions/_runtime_data_compress.unzlib-1.html +++ b/docs/functions/_runtime_data_compress.unzlib-1.html @@ -1,11 +1,11 @@ -unzlib | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 668ca0b..432bcb7 100644 --- a/docs/functions/_runtime_data_compress.unzlibSync.html +++ b/docs/functions/_runtime_data_compress.unzlibSync.html @@ -1,6 +1,6 @@ -unzlibSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 267fc8e..1adedb2 100644 --- a/docs/functions/_runtime_data_compress.zip-1.html +++ b/docs/functions/_runtime_data_compress.zip-1.html @@ -1,11 +1,11 @@ -zip | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 020a888..e6369e0 100644 --- a/docs/functions/_runtime_data_compress.zipSync.html +++ b/docs/functions/_runtime_data_compress.zipSync.html @@ -1,7 +1,7 @@ -zipSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function zipSync

      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 f56edab..24642c1 100644 --- a/docs/functions/_runtime_data_compress.zlib-1.html +++ b/docs/functions/_runtime_data_compress.zlib-1.html @@ -1,10 +1,10 @@ -zlib | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 c20e684..8f2f457 100644 --- a/docs/functions/_runtime_data_compress.zlibSync.html +++ b/docs/functions/_runtime_data_compress.zlibSync.html @@ -1,6 +1,6 @@ -zlibSync | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 3c9acf6..7617dcf 100644 --- a/docs/functions/_runtime_data_format_base64.atob.html +++ b/docs/functions/_runtime_data_format_base64.atob.html @@ -1,5 +1,5 @@ -atob | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function atob

      does what window.atob of web browsers do.

      -

      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 950ea38..7ef8b6f 100644 --- a/docs/functions/_runtime_data_format_base64.atobPolyfill.html +++ b/docs/functions/_runtime_data_format_base64.atobPolyfill.html @@ -1,3 +1,3 @@ -atobPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function atobPolyfill

      polyfill version of atob

      -
      • atobPolyfill(asc): string

      • Parameters

        • asc: string

        Returns string

      Settings

      Member Visibility
      \ No newline at end of file +atobPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function atobPolyfill

      polyfill version of atob

      +
      • atobPolyfill(asc: string): 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 792ecd6..af127c7 100644 --- a/docs/functions/_runtime_data_format_base64.btoa.html +++ b/docs/functions/_runtime_data_format_base64.btoa.html @@ -1,5 +1,5 @@ -btoa | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function btoa

      does what window.btoa of web browsers do.

      -

      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 623782e..98d9587 100644 --- a/docs/functions/_runtime_data_format_base64.btoaPolyfill.html +++ b/docs/functions/_runtime_data_format_base64.btoaPolyfill.html @@ -1,3 +1,3 @@ -btoaPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function btoaPolyfill

      polyfill version of btoa

      -
      • btoaPolyfill(bin): string

      • Parameters

        • bin: string

        Returns string

      Settings

      Member Visibility
      \ No newline at end of file +btoaPolyfill | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function btoaPolyfill

      polyfill version of btoa

      +
      • btoaPolyfill(bin: string): 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 afce8af..945702d 100644 --- a/docs/functions/_runtime_data_format_base64.btou.html +++ b/docs/functions/_runtime_data_format_base64.btou.html @@ -1,4 +1,4 @@ -btou | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +btou | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function btou

      Deprecated

      should have been internal use only.

      +
      • btou(b: string): 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 66c23b1..34a199f 100644 --- a/docs/functions/_runtime_data_format_base64.decode.html +++ b/docs/functions/_runtime_data_format_base64.decode.html @@ -1,5 +1,5 @@ -decode | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function decode

      converts a Base64 string to a UTF-8 string.

      -
      • decode(src): string

      • Parameters

      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 0b0dc00..ce63a71 100644 --- a/docs/functions/_runtime_data_format_base64.encode.html +++ b/docs/functions/_runtime_data_format_base64.encode.html @@ -1,5 +1,5 @@ -encode | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

          +encode | TyphonJS Runtime Library (FVTT) 0.2.0
          +

          Function encode

          converts a UTF-8-encoded string to a Base64 string.

          +
          • encode(src: string, urlsafe?: boolean): string

          • Parameters

            • src: string
            • Optionalurlsafe: boolean

              if true make the result URL-safe

            Returns string

            Base64 string

            -

          Settings

          Member Visibility
          \ 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 458cef1..6692c57 100644 --- a/docs/functions/_runtime_data_format_base64.encodeURI.html +++ b/docs/functions/_runtime_data_format_base64.encodeURI.html @@ -1,4 +1,4 @@ -encodeURI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +encodeURI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function encodeURI

      converts a UTF-8-encoded string to URL-safe Base64 RFC4648 §5.

      +
      • encodeURI(src: string): 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 305fdd7..30a2e2d 100644 --- a/docs/functions/_runtime_data_format_base64.extendBuiltins.html +++ b/docs/functions/_runtime_data_format_base64.extendBuiltins.html @@ -1,3 +1,3 @@ -extendBuiltins | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function extendBuiltins

      extend Builtin prototypes with relevant methods

      -
      • extendBuiltins(): void

      • Returns void

      Settings

      Member Visibility
      \ No newline at end of file +extendBuiltins | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 60bd958..7fd0dbf 100644 --- a/docs/functions/_runtime_data_format_base64.extendString.html +++ b/docs/functions/_runtime_data_format_base64.extendString.html @@ -1,3 +1,3 @@ -extendString | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function extendString

      extend String.prototype with relevant methods

      -
      • extendString(): void

      • Returns void

      Settings

      Member Visibility
      \ No newline at end of file +extendString | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 b033994..c54b7e7 100644 --- a/docs/functions/_runtime_data_format_base64.extendUint8Array.html +++ b/docs/functions/_runtime_data_format_base64.extendUint8Array.html @@ -1,3 +1,3 @@ -extendUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function extendUint8Array

      extend Uint8Array.prototype with relevant methods

      -
      • extendUint8Array(): void

      • Returns void

      Settings

      Member Visibility
      \ No newline at end of file +extendUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 a08d26f..91abfd7 100644 --- a/docs/functions/_runtime_data_format_base64.fromUint8Array.html +++ b/docs/functions/_runtime_data_format_base64.fromUint8Array.html @@ -1,5 +1,5 @@ -fromUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function fromUint8Array

      converts a Uint8Array to a Base64 string.

      -

      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 ef9dd39..aae1a06 100644 --- a/docs/functions/_runtime_data_format_base64.isValid.html +++ b/docs/functions/_runtime_data_format_base64.isValid.html @@ -1,4 +1,4 @@ -isValid | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +isValid | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function isValid

      check if a value is a valid Base64 string

      +
      • isValid(src: any): 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 a8956c7..6b098cf 100644 --- a/docs/functions/_runtime_data_format_base64.toUint8Array.html +++ b/docs/functions/_runtime_data_format_base64.toUint8Array.html @@ -1,3 +1,3 @@ -toUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function toUint8Array

      converts a Base64 string to a Uint8Array.

      -

      Settings

      Member Visibility
      \ No newline at end of file +toUint8Array | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 4ddc93a..fb582e8 100644 --- a/docs/functions/_runtime_data_format_base64.utob.html +++ b/docs/functions/_runtime_data_format_base64.utob.html @@ -1,4 +1,4 @@ -utob | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +utob | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function utob

      Deprecated

      should have been internal use only.

      +
      • utob(u: string): 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_jsonc.applyEdits.html b/docs/functions/_runtime_data_format_jsonc.applyEdits.html index 4deee7d..bd51018 100644 --- a/docs/functions/_runtime_data_format_jsonc.applyEdits.html +++ b/docs/functions/_runtime_data_format_jsonc.applyEdits.html @@ -1,7 +1,7 @@ -applyEdits | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function applyEdits

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.createScanner.html b/docs/functions/_runtime_data_format_jsonc.createScanner.html index 4d542f0..edf7c1e 100644 --- a/docs/functions/_runtime_data_format_jsonc.createScanner.html +++ b/docs/functions/_runtime_data_format_jsonc.createScanner.html @@ -1,4 +1,4 @@ -createScanner | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function createScanner

      Creates a JSON scanner on the given text. +createScanner | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Function createScanner

      Creates a JSON scanner on the given text. If ignoreTrivia is set, whitespaces or comments are ignored.

      -
      • createScanner(text, ignoreTrivia?): JSONScanner

      • Parameters

        • text: string
        • OptionalignoreTrivia: boolean

        Returns JSONScanner

      Settings

      Member Visibility
      \ No newline at end of file +
      • createScanner(text: string, ignoreTrivia?: boolean): JSONScanner

      • Parameters

        • text: string
        • OptionalignoreTrivia: boolean

        Returns JSONScanner

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.findNodeAtLocation.html b/docs/functions/_runtime_data_format_jsonc.findNodeAtLocation.html index 6f96fa2..c60e9aa 100644 --- a/docs/functions/_runtime_data_format_jsonc.findNodeAtLocation.html +++ b/docs/functions/_runtime_data_format_jsonc.findNodeAtLocation.html @@ -1,3 +1,3 @@ -findNodeAtLocation | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function findNodeAtLocation

      Finds the node at the given path in a JSON DOM.

      -

      Settings

      Member Visibility
      \ No newline at end of file +findNodeAtLocation | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function findNodeAtLocation

      Finds the node at the given path in a JSON DOM.

      +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.findNodeAtOffset.html b/docs/functions/_runtime_data_format_jsonc.findNodeAtOffset.html index ca61245..e7528d8 100644 --- a/docs/functions/_runtime_data_format_jsonc.findNodeAtOffset.html +++ b/docs/functions/_runtime_data_format_jsonc.findNodeAtOffset.html @@ -1,3 +1,3 @@ -findNodeAtOffset | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function findNodeAtOffset

      Finds the innermost node at the given offset. If includeRightBound is set, also finds nodes that end at the given offset.

      -
      • findNodeAtOffset(root, offset, includeRightBound?): Node

      • Parameters

        • root: Node
        • offset: number
        • OptionalincludeRightBound: boolean

        Returns Node

      Settings

      Member Visibility
      \ No newline at end of file +findNodeAtOffset | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function findNodeAtOffset

      Finds the innermost node at the given offset. If includeRightBound is set, also finds nodes that end at the given offset.

      +
      • findNodeAtOffset(root: Node, offset: number, includeRightBound?: boolean): Node

      • Parameters

        • root: Node
        • offset: number
        • OptionalincludeRightBound: boolean

        Returns Node

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.format.html b/docs/functions/_runtime_data_format_jsonc.format.html index a9b398d..f67f84f 100644 --- a/docs/functions/_runtime_data_format_jsonc.format.html +++ b/docs/functions/_runtime_data_format_jsonc.format.html @@ -1,8 +1,8 @@ -format | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function format

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.getLocation.html b/docs/functions/_runtime_data_format_jsonc.getLocation.html index aa4135c..2b0bdf9 100644 --- a/docs/functions/_runtime_data_format_jsonc.getLocation.html +++ b/docs/functions/_runtime_data_format_jsonc.getLocation.html @@ -1,3 +1,3 @@ -getLocation | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getLocation

      For a given offset, evaluate the location in the JSON document. Each segment in the location path is either a property name or an array index.

      -
      • getLocation(text, position): Location

      • Parameters

        • text: string
        • position: number

        Returns Location

      Settings

      Member Visibility
      \ No newline at end of file +getLocation | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function getLocation

      For a given offset, evaluate the location in the JSON document. Each segment in the location path is either a property name or an array index.

      +
      • getLocation(text: string, position: number): Location

      • Parameters

        • text: string
        • position: number

        Returns Location

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.getNodePath.html b/docs/functions/_runtime_data_format_jsonc.getNodePath.html index d637aff..37f0f92 100644 --- a/docs/functions/_runtime_data_format_jsonc.getNodePath.html +++ b/docs/functions/_runtime_data_format_jsonc.getNodePath.html @@ -1,3 +1,3 @@ -getNodePath | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getNodePath

      Gets the JSON path of the given JSON DOM node

      -

      Settings

      Member Visibility
      \ No newline at end of file +getNodePath | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function getNodePath

      Gets the JSON path of the given JSON DOM node

      +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.getNodeValue.html b/docs/functions/_runtime_data_format_jsonc.getNodeValue.html index 401da6b..30a7f21 100644 --- a/docs/functions/_runtime_data_format_jsonc.getNodeValue.html +++ b/docs/functions/_runtime_data_format_jsonc.getNodeValue.html @@ -1,3 +1,3 @@ -getNodeValue | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getNodeValue

      Evaluates the JavaScript object of the given JSON DOM node

      -
      • getNodeValue(node): any

      • Parameters

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file +getNodeValue | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function getNodeValue

      Evaluates the JavaScript object of the given JSON DOM node

      +
      • getNodeValue(node: Node): any

      • Parameters

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.modify.html b/docs/functions/_runtime_data_format_jsonc.modify.html index 488f98c..bd6b95f 100644 --- a/docs/functions/_runtime_data_format_jsonc.modify.html +++ b/docs/functions/_runtime_data_format_jsonc.modify.html @@ -1,5 +1,5 @@ -modify | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function modify

      • modify(text, path, value, options): EditResult

      • Computes the edit operations needed to modify a value in the JSON document.

        +modify | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function modify

        • modify(
              text: string,
              path: JSONPath,
              value: any,
              options: ModificationOptions,
          ): EditResult

        • Computes the edit operations needed to modify a value in the JSON document.

          Parameters

          • text: string
          • path: JSONPath

            The path of the value to change. The path represents either to the document root, a property or an array item. If the path points to an non-existing property or item, it will be created.

          • value: any

            The new value for the specified property or item. If the value is undefined, @@ -7,4 +7,4 @@

          • options: ModificationOptions

            Options

          Returns EditResult

          The edit operations describing the changes to the original document, following the format described in EditResult. To apply the edit operations to the input, use applyEdits.

          -

        Settings

        Member Visibility
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.parse.html b/docs/functions/_runtime_data_format_jsonc.parse.html index 573c7c7..3a169e0 100644 --- a/docs/functions/_runtime_data_format_jsonc.parse.html +++ b/docs/functions/_runtime_data_format_jsonc.parse.html @@ -1,4 +1,4 @@ -parse | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function parse

      Parses the given text and returns the object the JSON content represents. On invalid input, the parser tries to be as fault tolerant as possible, but still return a result. +parse | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Function parse

      Parses the given text and returns the object the JSON content represents. On invalid input, the parser tries to be as fault tolerant as possible, but still return a result. Therefore, always check the errors list to find out if the input was valid.

      -
      • parse(text, errors?, options?): any

      • Parameters

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.parseTree.html b/docs/functions/_runtime_data_format_jsonc.parseTree.html index 2328427..d847874 100644 --- a/docs/functions/_runtime_data_format_jsonc.parseTree.html +++ b/docs/functions/_runtime_data_format_jsonc.parseTree.html @@ -1,3 +1,3 @@ -parseTree | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function parseTree

      Parses the given text and returns a tree representation the JSON content. On invalid input, the parser tries to be as fault tolerant as possible, but still return a result.

      -

      Settings

      Member Visibility
      \ No newline at end of file +parseTree | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function parseTree

      Parses the given text and returns a tree representation the JSON content. On invalid input, the parser tries to be as fault tolerant as possible, but still return a result.

      +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.printParseErrorCode.html b/docs/functions/_runtime_data_format_jsonc.printParseErrorCode.html index 583389d..e38b9d9 100644 --- a/docs/functions/_runtime_data_format_jsonc.printParseErrorCode.html +++ b/docs/functions/_runtime_data_format_jsonc.printParseErrorCode.html @@ -1,2 +1,2 @@ -printParseErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function printParseErrorCode

      • printParseErrorCode(code):
            | "InvalidSymbol"
            | "InvalidNumberFormat"
            | "PropertyNameExpected"
            | "ValueExpected"
            | "ColonExpected"
            | "CommaExpected"
            | "CloseBraceExpected"
            | "CloseBracketExpected"
            | "EndOfFileExpected"
            | "InvalidCommentToken"
            | "UnexpectedEndOfComment"
            | "UnexpectedEndOfString"
            | "UnexpectedEndOfNumber"
            | "InvalidUnicode"
            | "InvalidEscapeCharacter"
            | "InvalidCharacter"
            | "<unknown ParseErrorCode>"

      • Parameters

        Returns
            | "InvalidSymbol"
            | "InvalidNumberFormat"
            | "PropertyNameExpected"
            | "ValueExpected"
            | "ColonExpected"
            | "CommaExpected"
            | "CloseBraceExpected"
            | "CloseBracketExpected"
            | "EndOfFileExpected"
            | "InvalidCommentToken"
            | "UnexpectedEndOfComment"
            | "UnexpectedEndOfString"
            | "UnexpectedEndOfNumber"
            | "InvalidUnicode"
            | "InvalidEscapeCharacter"
            | "InvalidCharacter"
            | "<unknown ParseErrorCode>"

      Settings

      Member Visibility
      \ No newline at end of file +printParseErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function printParseErrorCode

      • printParseErrorCode(
            code: ParseErrorCode,
        ):
            | "InvalidSymbol"
            | "InvalidNumberFormat"
            | "PropertyNameExpected"
            | "ValueExpected"
            | "ColonExpected"
            | "CommaExpected"
            | "CloseBraceExpected"
            | "CloseBracketExpected"
            | "EndOfFileExpected"
            | "InvalidCommentToken"
            | "UnexpectedEndOfComment"
            | "UnexpectedEndOfString"
            | "UnexpectedEndOfNumber"
            | "InvalidUnicode"
            | "InvalidEscapeCharacter"
            | "InvalidCharacter"
            | "<unknown ParseErrorCode>"

      • Parameters

        Returns
            | "InvalidSymbol"
            | "InvalidNumberFormat"
            | "PropertyNameExpected"
            | "ValueExpected"
            | "ColonExpected"
            | "CommaExpected"
            | "CloseBraceExpected"
            | "CloseBracketExpected"
            | "EndOfFileExpected"
            | "InvalidCommentToken"
            | "UnexpectedEndOfComment"
            | "UnexpectedEndOfString"
            | "UnexpectedEndOfNumber"
            | "InvalidUnicode"
            | "InvalidEscapeCharacter"
            | "InvalidCharacter"
            | "<unknown ParseErrorCode>"

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.stripComments.html b/docs/functions/_runtime_data_format_jsonc.stripComments.html index 18ef325..4a72601 100644 --- a/docs/functions/_runtime_data_format_jsonc.stripComments.html +++ b/docs/functions/_runtime_data_format_jsonc.stripComments.html @@ -1,5 +1,5 @@ -stripComments | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function stripComments

      Takes JSON with JavaScript-style comments and remove +stripComments | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Function stripComments

      Takes JSON with JavaScript-style comments and remove them. Optionally replaces every none-newline character of comments with a replaceCharacter

      -
      • stripComments(text, replaceCh?): string

      • Parameters

        • text: string
        • OptionalreplaceCh: string

        Returns string

      Settings

      Member Visibility
      \ No newline at end of file +
      • stripComments(text: string, replaceCh?: string): string

      • Parameters

        • text: string
        • OptionalreplaceCh: string

        Returns string

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_data_format_jsonc.visit.html b/docs/functions/_runtime_data_format_jsonc.visit.html index 173eb75..f54b0dc 100644 --- a/docs/functions/_runtime_data_format_jsonc.visit.html +++ b/docs/functions/_runtime_data_format_jsonc.visit.html @@ -1,3 +1,3 @@ -visit | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function visit

      Parses the given text and invokes the visitor functions for each object, array and literal reached.

      -
      • visit(text, visitor, options?): any

      • Parameters

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file +visit | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function visit

      Parses the given text and invokes the visitor functions for each object, array and literal reached.

      +

      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 d72bcb4..ceba588 100644 --- a/docs/functions/_runtime_data_format_msgpack.addExtension.html +++ b/docs/functions/_runtime_data_format_msgpack.addExtension.html @@ -1,2 +1,2 @@ -addExtension | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function addExtension

      • addExtension(extension): void

      • Parameters

        • extension: Extension

        Returns void

      Settings

      Member Visibility
      \ No newline at end of file +addExtension | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function addExtension

      • addExtension(extension: 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 cb3d95d..d2c97dc 100644 --- a/docs/functions/_runtime_data_format_msgpack.clearSource.html +++ b/docs/functions/_runtime_data_format_msgpack.clearSource.html @@ -1,2 +1,2 @@ -clearSource | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function clearSource

      • clearSource(): void

      • Returns void

      Settings

      Member Visibility
      \ No newline at end of file +clearSource | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 4fc6210..a6abe60 100644 --- a/docs/functions/_runtime_data_format_msgpack.decode.html +++ b/docs/functions/_runtime_data_format_msgpack.decode.html @@ -1,2 +1,2 @@ -decode | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function decode

      • decode(messagePack, options?): any

      • Parameters

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file +decode | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function decode

      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 0380cae..3353f02 100644 --- a/docs/functions/_runtime_data_format_msgpack.encode.html +++ b/docs/functions/_runtime_data_format_msgpack.encode.html @@ -1,2 +1,2 @@ -encode | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function encode

      • encode(value, encodeOptions?): Buffer

      • Parameters

        • value: any
        • OptionalencodeOptions: number

        Returns Buffer

      Settings

      Member Visibility
      \ No newline at end of file +encode | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function encode

      • encode(value: any, encodeOptions?: number): Buffer

      • Parameters

        • value: any
        • OptionalencodeOptions: number

        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 d1c795c..15444c9 100644 --- a/docs/functions/_runtime_data_format_msgpack.pack.html +++ b/docs/functions/_runtime_data_format_msgpack.pack.html @@ -1,2 +1,2 @@ -pack | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function pack

      • pack(value, encodeOptions?): Buffer

      • Parameters

        • value: any
        • OptionalencodeOptions: number

        Returns Buffer

      Settings

      Member Visibility
      \ No newline at end of file +pack | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function pack

      • pack(value: any, encodeOptions?: number): Buffer

      • Parameters

        • value: any
        • OptionalencodeOptions: number

        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 d3e209a..5da921c 100644 --- a/docs/functions/_runtime_data_format_msgpack.roundFloat32.html +++ b/docs/functions/_runtime_data_format_msgpack.roundFloat32.html @@ -1,2 +1,2 @@ -roundFloat32 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function roundFloat32

      • roundFloat32(float32Number): number

      • Parameters

        • float32Number: number

        Returns number

      Settings

      Member Visibility
      \ No newline at end of file +roundFloat32 | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function roundFloat32

      • roundFloat32(float32Number: number): 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 d3d98ad..761eb99 100644 --- a/docs/functions/_runtime_data_format_msgpack.unpack.html +++ b/docs/functions/_runtime_data_format_msgpack.unpack.html @@ -1,2 +1,2 @@ -unpack | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function unpack

      • unpack(messagePack, options?): any

      • Parameters

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file +unpack | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function unpack

      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 4bed2ba..5a2ec02 100644 --- a/docs/functions/_runtime_data_format_msgpack.unpackMultiple.html +++ b/docs/functions/_runtime_data_format_msgpack.unpackMultiple.html @@ -1,2 +1,2 @@ -unpackMultiple | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +unpackMultiple | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function unpackMultiple

      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 d32f6da..1d03a91 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpack.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpack.html @@ -1,7 +1,7 @@ -inflateAndUnpack | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function inflateAndUnpack

      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 1b2d7fa..d0c2468 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpackB64.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.inflateAndUnpackB64.html @@ -1,8 +1,8 @@ -inflateAndUnpackB64 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function inflateAndUnpackB64

        • inflateAndUnpackB64(
              data: string,
              opts?: { inflateOptions?: InflateOptions },
          ): 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

            -
          • Optionalopts: {
                inflateOptions?: InflateOptions;
            }

            Optional parameters.

            -

          Returns any

          Inflated and unpacked data.

          -

        Settings

        Member Visibility
        \ 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 403797a..9d1a195 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflate.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflate.html @@ -1,8 +1,8 @@ -packAndDeflate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 9fb6640..14b2a89 100644 --- a/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflateB64.html +++ b/docs/functions/_runtime_data_format_msgpack_compress.packAndDeflateB64.html @@ -1,9 +1,9 @@ -packAndDeflateB64 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function packAndDeflateB64

        • packAndDeflateB64(
              data: any,
              opts?: { deflateOptions?: DeflateOptions; urlsafe?: boolean },
          ): 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.

            -
          • Optionalopts: {
                deflateOptions?: DeflateOptions;
                urlsafe?: boolean;
            }

            Optional parameters.

            -
            • OptionaldeflateOptions?: DeflateOptions

              Deflate options.

              -
            • Optionalurlsafe?: 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
        \ 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 0ebfdeb..033af84 100644 --- a/docs/functions/_runtime_data_format_unicode.graphemeIterator.html +++ b/docs/functions/_runtime_data_format_unicode.graphemeIterator.html @@ -1,8 +1,8 @@ -graphemeIterator | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function graphemeIterator

      • graphemeIterator(str): IterableIterator<string>

      • Provides an iterator for tokenizing a string by grapheme clusters.

        +graphemeIterator | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function graphemeIterator

        • graphemeIterator(str: string): 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
        \ 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 efb5041..a0f595c 100644 --- a/docs/functions/_runtime_data_format_unicode.graphemeSplit.html +++ b/docs/functions/_runtime_data_format_unicode.graphemeSplit.html @@ -1,5 +1,5 @@ -graphemeSplit | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function graphemeSplit

      • graphemeSplit(str): string[]

      • Splits the given string into an array of Unicode grapheme clusters.

        +graphemeSplit | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function graphemeSplit

        • graphemeSplit(str: string): 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
        \ 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 4868037..466c3d3 100644 --- a/docs/functions/_runtime_data_struct_hash_array.getValueFromKey.html +++ b/docs/functions/_runtime_data_struct_hash_array.getValueFromKey.html @@ -1,6 +1,6 @@ -getValueFromKey | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function getValueFromKey

        • getValueFromKey(item: object, key: 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
        \ No newline at end of file +

      Settings

      Member Visibility
      \ 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 9657e7d..b3db468 100644 --- a/docs/functions/_runtime_math_interpolate.lerp.html +++ b/docs/functions/_runtime_math_interpolate.lerp.html @@ -1,7 +1,7 @@ -lerp | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function lerp

        • lerp(start: number, end: number, amount: number): 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
        \ 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 1f8986a..0fd42bb 100644 --- a/docs/functions/_runtime_math_util.clamp.html +++ b/docs/functions/_runtime_math_util.clamp.html @@ -1,7 +1,7 @@ -clamp | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function clamp

      • clamp(value?, min?, max?): number

      • Clamps a value between min / max values.

        +clamp | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function clamp

        • clamp(value?: number, min?: number, max?: number): 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
        \ 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 217fb2c..55861d2 100644 --- a/docs/functions/_runtime_math_util.degToRad.html +++ b/docs/functions/_runtime_math_util.degToRad.html @@ -1,5 +1,5 @@ -degToRad | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function degToRad

      • degToRad(deg): number

      • Converts the given number from degrees to radians.

        +degToRad | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function degToRad

        • degToRad(deg: number): number

        • Converts the given number from degrees to radians.

          Parameters

          • deg: number

            Degree number to convert

          Returns number

          Degree as radians.

          -

        Settings

        Member Visibility
        \ 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 2bfcd6e..6f82d51 100644 --- a/docs/functions/_runtime_math_util.radToDeg.html +++ b/docs/functions/_runtime_math_util.radToDeg.html @@ -1,5 +1,5 @@ -radToDeg | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function radToDeg

      • radToDeg(rad): number

      • Converts the given number from radians to degrees.

        +radToDeg | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function radToDeg

        • radToDeg(rad: number): number

        • Converts the given number from radians to degrees.

          Parameters

          • rad: number

            Radian number to convert.

          Returns number

          Degree as radians.

          -

        Settings

        Member Visibility
        \ 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 9ddaff6..3c9d074 100644 --- a/docs/functions/_runtime_plugin_manager.escapeTarget.html +++ b/docs/functions/_runtime_plugin_manager.escapeTarget.html @@ -1,7 +1,7 @@ -escapeTarget | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function escapeTarget

        • escapeTarget(target: string | URL): 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.

            +

            Parameters

            • target: string | URL

              Target full / relative path or URL to escape.

            Returns string

            The escaped target.

            -

        Settings

        Member Visibility
        \ 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 e7b6017..c5c3acb 100644 --- a/docs/functions/_runtime_plugin_manager.isValidConfig.html +++ b/docs/functions/_runtime_plugin_manager.isValidConfig.html @@ -1,5 +1,5 @@ -isValidConfig | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function isValidConfig

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_focus.isFocused.html b/docs/functions/_runtime_svelte_action_dom_focus.isFocused.html index e93a8ed..71fa69d 100644 --- a/docs/functions/_runtime_svelte_action_dom_focus.isFocused.html +++ b/docs/functions/_runtime_svelte_action_dom_focus.isFocused.html @@ -1,8 +1,8 @@ -isFocused | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function isFocused

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_input.keyforward.html b/docs/functions/_runtime_svelte_action_dom_input.keyforward.html index 2709b28..8265e8b 100644 --- a/docs/functions/_runtime_svelte_action_dom_input.keyforward.html +++ b/docs/functions/_runtime_svelte_action_dom_input.keyforward.html @@ -1,8 +1,8 @@ -keyforward | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function keyforward

      Returns ActionReturn<
          {
              keydown: (event: KeyboardEvent) => void;
              keyup: (event: KeyboardEvent) => void;
          },
      >

      Action lifecycle methods.

      +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_input.useTinykeys.html b/docs/functions/_runtime_svelte_action_dom_input.useTinykeys.html index 3a887ea..9687a52 100644 --- a/docs/functions/_runtime_svelte_action_dom_input.useTinykeys.html +++ b/docs/functions/_runtime_svelte_action_dom_input.useTinykeys.html @@ -1,6 +1,6 @@ -useTinykeys | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function useTinykeys

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver-1.updateCache.html b/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver-1.updateCache.html deleted file mode 100644 index ee05348..0000000 --- a/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver-1.updateCache.html +++ /dev/null @@ -1,6 +0,0 @@ -updateCache | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.html b/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.html index 01b5545..d7d2ada 100644 --- a/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.html +++ b/docs/functions/_runtime_svelte_action_dom_observer.resizeObserver.html @@ -1,5 +1,5 @@ -resizeObserver | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function resizeObserver

      Settings

      Member Visibility
      \ No newline at end of file +

      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_dom_properties.applyScrolltop.html b/docs/functions/_runtime_svelte_action_dom_properties.applyScrolltop.html index a7bca1b..9e6c720 100644 --- a/docs/functions/_runtime_svelte_action_dom_properties.applyScrolltop.html +++ b/docs/functions/_runtime_svelte_action_dom_properties.applyScrolltop.html @@ -1,5 +1,5 @@ -applyScrolltop | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function applyScrolltop

      • applyScrolltop(element, store): ActionReturn<MinimalWritable<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

        +

        Function applyScrolltop

        • applyScrolltop(
              element: HTMLElement,
              store: MinimalWritable<number>,
          ): ActionReturn<MinimalWritable<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.

          @@ -7,4 +7,4 @@
        • store: MinimalWritable<number>

          A minimal writable store that stores the element scrollTop.

        Returns ActionReturn<MinimalWritable<number>>

        Lifecycle functions.

        -

      Settings

      Member Visibility
      \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_properties.toggleDetails.html b/docs/functions/_runtime_svelte_action_dom_properties.toggleDetails.html index 0f2e851..7ce0db8 100644 --- a/docs/functions/_runtime_svelte_action_dom_properties.toggleDetails.html +++ b/docs/functions/_runtime_svelte_action_dom_properties.toggleDetails.html @@ -1,5 +1,5 @@ -toggleDetails | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function toggleDetails

      • toggleDetails(details, opts?): ActionReturn

      • Provides a toggle action for details HTML elements. The boolean store when provided controls open / closed state. +toggleDetails | TyphonJS Runtime Library (FVTT) 0.2.0

        +

        Function toggleDetails

        • toggleDetails(
              details: HTMLDetailsElement,
              opts?: {
                  animate?: boolean;
                  clickActive?: boolean;
                  enabled?: boolean;
                  store: MinimalWritable<boolean>;
              },
          ): ActionReturn

        • Provides a toggle action for details HTML elements. The boolean store when provided controls open / closed state. Animation is accomplished using WAAPI controlling the height of the details element. It should be noted that this animation may cause layout thrashing (reflows) depending on the amount of DOM elements on the page though this doesn't occur under most situations. Animation can be toggled on / off with the animate option.

          @@ -7,10 +7,10 @@

          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.

            -
          • Optionalopts: {
                animate?: boolean;
                clickActive?: boolean;
                enabled?: boolean;
                store: MinimalWritable<boolean>;
            }

            Options parameters.

            -
            • Optionalanimate?: boolean

              When true animate close / open state with WAAPI.

              -
            • OptionalclickActive?: boolean

              When false click events are not handled.

              -
            • Optionalenabled?: boolean

              When false store changes and click events are not handled.

              -
            • store: MinimalWritable<boolean>

              A minimal writable boolean store.

              +
            • Optionalopts: {
                  animate?: boolean;
                  clickActive?: boolean;
                  enabled?: boolean;
                  store: MinimalWritable<boolean>;
              }

              Options parameters.

              +
              • Optionalanimate?: boolean

                When true animate close / open state with WAAPI.

                +
              • OptionalclickActive?: boolean

                When false click events are not handled.

                +
              • Optionalenabled?: boolean

                When false store changes and click events are not handled.

                +
              • store: MinimalWritable<boolean>

                A minimal writable boolean store.

          Returns ActionReturn

          Lifecycle functions.

          -

        Settings

        Member Visibility
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_action_dom_style.applyStyles.html b/docs/functions/_runtime_svelte_action_dom_style.applyStyles.html index cbb01b6..92a5797 100644 --- a/docs/functions/_runtime_svelte_action_dom_style.applyStyles.html +++ b/docs/functions/_runtime_svelte_action_dom_style.applyStyles.html @@ -1,7 +1,7 @@ -applyStyles | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function applyStyles

      • applyStyles(node, properties): ActionReturn<{
            [key: string]: string | null;
        }>

      • Provides an action to apply CSS style properties provided as an object.

        +applyStyles | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function applyStyles

        • applyStyles(
              node: HTMLElement,
              properties: { [key: string]: string },
          ): ActionReturn<{ [key: string]: string }>

        • Provides an action to apply CSS style properties provided as an object.

          Parameters

          • node: HTMLElement

            Target element

            -
          • properties: {
                [key: string]: string | null;
            }

            Hyphen case CSS property key / value object of properties +

          • properties: { [key: string]: string }

            Hyphen case CSS property key / value object of properties to set.

            -
            • [key: string]: string | null

          Returns ActionReturn<{
              [key: string]: string | null;
          }>

          Lifecycle functions.

          -

        Settings

        Member Visibility
        \ No newline at end of file +

      Returns ActionReturn<{ [key: string]: string }>

      Lifecycle functions.

      +

      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 7b20bfa..d857924 100644 --- a/docs/functions/_runtime_svelte_action_util.dynamicAction.html +++ b/docs/functions/_runtime_svelte_action_util.dynamicAction.html @@ -1,8 +1,8 @@ -dynamicAction | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function dynamicAction

      Returns ActionReturn<DynamicActionOptions>

      The action lifecycle methods.

      -

      Settings

      Member Visibility
      \ No newline at end of file +

      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 f858c92..2444464 100644 --- a/docs/functions/_runtime_svelte_animate.animateEvents.html +++ b/docs/functions/_runtime_svelte_animate.animateEvents.html @@ -1,5 +1,5 @@ -animateEvents | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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.

        +animateEvents | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function animateEvents

        • animateEvents(
              fn: (
                  node: Element,
                  data: { from: DOMRect; to: DOMRect },
                  ...rest: any,
              ) => AnimationConfig,
              store?: MinimalWritable<boolean>,
          ): (
              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.

          @@ -7,14 +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: 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}
+

          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 +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_animate_gsap.draggableGsap-1.options.html b/docs/functions/_runtime_svelte_animate_gsap.draggableGsap-1.options.html deleted file mode 100644 index 9d447b0..0000000 --- a/docs/functions/_runtime_svelte_animate_gsap.draggableGsap-1.options.html +++ /dev/null @@ -1,5 +0,0 @@ -options | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function options

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.html b/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.html index fa5cc9c..d0ccc0b 100644 --- a/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.html +++ b/docs/functions/_runtime_svelte_animate_gsap.draggableGsap.html @@ -1,5 +1,5 @@ -draggableGsap | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function draggableGsap

      Settings

      Member Visibility
      \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_animate_gsap.getGsapEasingFunc.html b/docs/functions/_runtime_svelte_animate_gsap.getGsapEasingFunc.html index 8c04981..445a129 100644 --- a/docs/functions/_runtime_svelte_animate_gsap.getGsapEasingFunc.html +++ b/docs/functions/_runtime_svelte_animate_gsap.getGsapEasingFunc.html @@ -1,10 +1,10 @@ -getGsapEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getGsapEasingFunc

      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 646f73e..dec5f2f 100644 --- a/docs/functions/_runtime_svelte_easing.getEasingFunc.html +++ b/docs/functions/_runtime_svelte_easing.getEasingFunc.html @@ -1,11 +1,11 @@ -getEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getEasingFunc

      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 77a6f50..561bb83 100644 --- a/docs/functions/_runtime_svelte_store_position.applyPosition.html +++ b/docs/functions/_runtime_svelte_store_position.applyPosition.html @@ -1,7 +1,7 @@ -applyPosition | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function applyPosition

      Returns ActionReturn<TJSPosition | Positionable>

      The action lifecycle methods.

      +

      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 deleted file mode 100644 index 6f83598..0000000 --- a/docs/functions/_runtime_svelte_store_position.draggable-1.options.html +++ /dev/null @@ -1,5 +0,0 @@ -options | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function options

      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 020fe58..add05e8 100644 --- a/docs/functions/_runtime_svelte_store_position.draggable.html +++ b/docs/functions/_runtime_svelte_store_position.draggable.html @@ -1,9 +1,9 @@ -draggable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function draggable

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_util.isMinimalWritableStore.html b/docs/functions/_runtime_svelte_store_util.isMinimalWritableStore.html index 7373da2..7ecb2ff 100644 --- a/docs/functions/_runtime_svelte_store_util.isMinimalWritableStore.html +++ b/docs/functions/_runtime_svelte_store_util.isMinimalWritableStore.html @@ -1,7 +1,7 @@ -isMinimalWritableStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function isMinimalWritableStore

      • isMinimalWritableStore(store): boolean

      • Provides a basic test for a given variable to test if it has the shape of a minimal writable store by having a +isMinimalWritableStore | TyphonJS Runtime Library (FVTT) 0.2.0

        +

        Function isMinimalWritableStore

        • isMinimalWritableStore(store: any): boolean

        • Provides a basic test for a given variable to test if it has the shape of a minimal writable store by having a subscribe and set 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 MinimalWritable store.

          -

        Settings

        Member Visibility
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_util.isReadableStore.html b/docs/functions/_runtime_svelte_store_util.isReadableStore.html index 76b16b1..d757350 100644 --- a/docs/functions/_runtime_svelte_store_util.isReadableStore.html +++ b/docs/functions/_runtime_svelte_store_util.isReadableStore.html @@ -1,7 +1,7 @@ -isReadableStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function isReadableStore

        • isReadableStore(store: any): 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
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_util.isWritableStore.html b/docs/functions/_runtime_svelte_store_util.isWritableStore.html index 54ff82b..49e4681 100644 --- a/docs/functions/_runtime_svelte_store_util.isWritableStore.html +++ b/docs/functions/_runtime_svelte_store_util.isWritableStore.html @@ -1,8 +1,8 @@ -isWritableStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function isWritableStore

        • isWritableStore(store: any): 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, and update` 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
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_util.subscribeFirstRest.html b/docs/functions/_runtime_svelte_store_util.subscribeFirstRest.html index dab1621..567a31b 100644 --- a/docs/functions/_runtime_svelte_store_util.subscribeFirstRest.html +++ b/docs/functions/_runtime_svelte_store_util.subscribeFirstRest.html @@ -1,8 +1,8 @@ -subscribeFirstRest | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function subscribeFirstRest

        • subscribeFirstRest(
              store: Readable<any> | Writable<any>,
              first: any,
              update: any,
          ): 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...

            +

            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
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_svelte_store_util.subscribeIgnoreFirst.html b/docs/functions/_runtime_svelte_store_util.subscribeIgnoreFirst.html index 342a4f6..446cb64 100644 --- a/docs/functions/_runtime_svelte_store_util.subscribeIgnoreFirst.html +++ b/docs/functions/_runtime_svelte_store_util.subscribeIgnoreFirst.html @@ -1,7 +1,7 @@ -subscribeIgnoreFirst | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function subscribeIgnoreFirst

      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 deleted file mode 100644 index 67f5039..0000000 --- a/docs/functions/_runtime_svelte_store_web_storage.storeGenerator.html +++ /dev/null @@ -1,12 +0,0 @@ -storeGenerator | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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: 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
      \ 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 deleted file mode 100644 index d17cb19..0000000 --- a/docs/functions/_runtime_svelte_store_writable_derived.propertyStore.html +++ /dev/null @@ -1,8 +0,0 @@ -propertyStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      \ 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 deleted file mode 100644 index 747f7d5..0000000 --- a/docs/functions/_runtime_svelte_store_writable_derived.writableDerived.html +++ /dev/null @@ -1,15 +0,0 @@ -writableDerived | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function writableDerived

      • writableDerived<S, T>(origins, derive, reflect, initial?): Writable<T>

      • Create a store similar to Svelte's derived, but which -has its own set and update methods and can send values back to the origin stores. -Read more...

        -

        Type Parameters

        Parameters

        • origins: S

          One or more stores to derive from. Same as -derived's 1st parameter.

          -
        • derive: ((values: StoresValues<S>) => T)

          The callback to determine the derived value. Same as -derived's 2nd parameter.

          -
        • reflect: ((reflecting: T, old: StoresValues<S>) => SetValues<S>)

          Called when the -derived store gets a new value via its set or update methods, and determines new values for -the origin stores. Read more...

          -
        • Optionalinitial: T

          The new store's initial value. Same as -derived's 3rd parameter.

          -

        Returns Writable<T>

        A writable store.

        -
      • writableDerived<S, T>(origins, derive, reflect, initial?): Writable<T>

      • Type Parameters

        Parameters

        Returns Writable<T>

      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 81f9ed6..5205cda 100644 --- a/docs/functions/_runtime_svelte_transition.rotate.html +++ b/docs/functions/_runtime_svelte_transition.rotate.html @@ -1,15 +1,15 @@ -rotate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function rotate

        • rotate(
              node: HTMLElement,
              options?: {
                  delay?: number;
                  duration?: number;
                  easing?: EasingReference;
                  end?: number;
                  initial?: number;
              },
          ): 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.

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

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

                +
              • Optionalend?: number

                End rotation in degrees.

                +
              • Optionalinitial?: number

                Initial rotation in degrees.

          Returns TransitionConfig

          Transition config.

          -

        Settings

        Member Visibility
        \ 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 8e9ad7e..1a74107 100644 --- a/docs/functions/_runtime_svelte_transition.rotateFade.html +++ b/docs/functions/_runtime_svelte_transition.rotateFade.html @@ -1,20 +1,20 @@ -rotateFade | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function rotateFade

        • rotateFade(
              node: HTMLElement,
              options?: {
                  delay?: number;
                  duration?: number;
                  easing?: EasingReference;
                  easingFade?: EasingReference;
                  easingRotate?: EasingReference;
                  end?: number;
                  initial?: number;
              },
          ): 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.

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

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

              • OptionaleasingFade?: EasingReference

                Easing function name or function to apply to the fade transition.

                -
              • OptionaleasingRotate?: EasingReference

                Easing function name or +

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

                +
              • Optionalend?: number

                End rotation in degrees.

                +
              • Optionalinitial?: number

                Initial rotation in degrees.

          Returns TransitionConfig

          Transition config.

          -

        Settings

        Member Visibility
        \ 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 56044dc..bd21ae2 100644 --- a/docs/functions/_runtime_svelte_transition.slideFade.html +++ b/docs/functions/_runtime_svelte_transition.slideFade.html @@ -1,16 +1,16 @@ -slideFade | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function slideFade

        • slideFade(
              node: HTMLElement,
              options?: {
                  axis?: "x" | "y";
                  delay?: number;
                  duration?: number;
                  easing?: EasingReference;
                  easingFade?: EasingReference;
                  easingSlide?: EasingReference;
              },
          ): 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.

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

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

              • OptionaleasingFade?: EasingReference

                Easing function name or function to apply to the fade transition.

                -
              • OptionaleasingSlide?: EasingReference

                Easing function name or +

              • OptionaleasingSlide?: EasingReference

                Easing function name or function to apply to the slide transition.

          Returns TransitionConfig

          Transition config.

          -

        Settings

        Member Visibility
        \ 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 081fdee..1571dfc 100644 --- a/docs/functions/_runtime_svelte_transition.toAnimation.html +++ b/docs/functions/_runtime_svelte_transition.toAnimation.html @@ -1,8 +1,8 @@ -toAnimation | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +toAnimation | TyphonJS Runtime Library (FVTT) 0.2.0

        +

        Function toAnimation

        • toAnimation(
              fn: (node: Element, ...rest: any[]) => TransitionConfig,
          ): (
              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: Element, data: {
              from: DOMRect;
              to: DOMRect;
          }, ...rest: any) => any)

            +

        Parameters

        Returns (node: Element, data: { from: DOMRect; to: DOMRect }, ...rest: any) => any

        • Transition function converted to an animation.
        -

      Settings

      Member Visibility
      \ 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 8420d21..694b9d3 100644 --- a/docs/functions/_runtime_util_animate.nextAnimationFrame.html +++ b/docs/functions/_runtime_util_animate.nextAnimationFrame.html @@ -1,6 +1,6 @@ -nextAnimationFrame | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function nextAnimationFrame

        • nextAnimationFrame(cntr?: number): Promise<number>

        • Awaits requestAnimationFrame calls by the counter specified. This allows asynchronous applications for direct / inline style modification amongst other direct animation techniques.

          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
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_dom_input_tinykeys.createKeybindingsHandler.html b/docs/functions/_runtime_util_dom_input_tinykeys.createKeybindingsHandler.html index 9c409b1..5933a0e 100644 --- a/docs/functions/_runtime_util_dom_input_tinykeys.createKeybindingsHandler.html +++ b/docs/functions/_runtime_util_dom_input_tinykeys.createKeybindingsHandler.html @@ -1,6 +1,6 @@ -createKeybindingsHandler | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function createKeybindingsHandler

      • createKeybindingsHandler(keyBindingMap, options?): EventListener

      • Creates an event listener for handling keybindings.

        -

        Parameters

        Returns EventListener

        Example

        import { createKeybindingsHandler } from "../src/keybindings"

        let handler = createKeybindingsHandler({
        	"Shift+d": () => {
        		alert("The 'Shift' and 'd' keys were pressed at the same time")
        	},
        	"y e e t": () => {
        		alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
        	},
        	"$mod+d": () => {
        		alert("Either 'Control+d' or 'Meta+d' were pressed")
        	},
        })

        window.addEvenListener("keydown", handler)
+createKeybindingsHandler | TyphonJS Runtime Library (FVTT) 0.2.0
        
+
        Function createKeybindingsHandler
        • createKeybindingsHandler(
              keyBindingMap: KeyBindingMap,
              options?: KeyBindingHandlerOptions,
          ): EventListener
        • Creates an event listener for handling keybindings.
          
+
          Parameters
          Returns EventListener
          Example
          import { createKeybindingsHandler } from "../src/keybindings"

          let handler = createKeybindingsHandler({
          	"Shift+d": () => {
          		alert("The 'Shift' and 'd' keys were pressed at the same time")
          	},
          	"y e e t": () => {
          		alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
          	},
          	"$mod+d": () => {
          		alert("Either 'Control+d' or 'Meta+d' were pressed")
          	},
          })

          window.addEvenListener("keydown", handler)
 
          
 
-
        Settings
        Member Visibility
        
\ No newline at end of file
+

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_dom_input_tinykeys.matchKeyBindingPress.html b/docs/functions/_runtime_util_dom_input_tinykeys.matchKeyBindingPress.html index 309cede..13a9a90 100644 --- a/docs/functions/_runtime_util_dom_input_tinykeys.matchKeyBindingPress.html +++ b/docs/functions/_runtime_util_dom_input_tinykeys.matchKeyBindingPress.html @@ -1,3 +1,3 @@ -matchKeyBindingPress | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function matchKeyBindingPress

      • matchKeyBindingPress(event, __namedParameters): boolean

      • This tells us if a single keyboard event matches a single keybinding press.

        -

        Parameters

        Returns boolean

      Settings

      Member Visibility
      \ No newline at end of file +matchKeyBindingPress | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function matchKeyBindingPress

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_dom_input_tinykeys.parseKeybinding.html b/docs/functions/_runtime_util_dom_input_tinykeys.parseKeybinding.html index 9ffe09d..0c8c025 100644 --- a/docs/functions/_runtime_util_dom_input_tinykeys.parseKeybinding.html +++ b/docs/functions/_runtime_util_dom_input_tinykeys.parseKeybinding.html @@ -1,9 +1,9 @@ -parseKeybinding | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function parseKeybinding

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_dom_input_tinykeys.tinykeys.html b/docs/functions/_runtime_util_dom_input_tinykeys.tinykeys.html index 60928e2..368d8ea 100644 --- a/docs/functions/_runtime_util_dom_input_tinykeys.tinykeys.html +++ b/docs/functions/_runtime_util_dom_input_tinykeys.tinykeys.html @@ -1,7 +1,7 @@ -tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function tinykeys

      • tinykeys(target, keyBindingMap, __namedParameters?): (() => void)

      • Subscribes to keybindings.

        +tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function tinykeys

        • tinykeys(
              target: HTMLElement | Window,
              keyBindingMap: KeyBindingMap,
              __namedParameters?: KeyBindingOptions,
          ): () => void

        • Subscribes to keybindings.

          Returns an unsubscribe method.

          -

          Parameters

          Returns (() => void)

            • (): void

            • Returns void

          Example

          import { tinykeys } from "../src/tinykeys"

          tinykeys(window, {
          	"Shift+d": () => {
          		alert("The 'Shift' and 'd' keys were pressed at the same time")
          	},
          	"y e e t": () => {
          		alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
          	},
          	"$mod+d": () => {
          		alert("Either 'Control+d' or 'Meta+d' were pressed")
          	},
          })
+

          Parameters

          Returns () => void

          Example

          import { tinykeys } from "../src/tinykeys"

          tinykeys(window, {
          	"Shift+d": () => {
          		alert("The 'Shift' and 'd' keys were pressed at the same time")
          	},
          	"y e e t": () => {
          		alert("The keys 'y', 'e', 'e', and 't' were pressed in order")
          	},
          	"$mod+d": () => {
          		alert("Either 'Control+d' or 'Meta+d' were pressed")
          	},
          })
          -

        Settings

        Member Visibility
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_dom_layout.getStackingContext.html b/docs/functions/_runtime_util_dom_layout.getStackingContext.html index b9ca223..d67d8b4 100644 --- a/docs/functions/_runtime_util_dom_layout.getStackingContext.html +++ b/docs/functions/_runtime_util_dom_layout.getStackingContext.html @@ -1,11 +1,11 @@ -getStackingContext | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getStackingContext

      Settings

      Member Visibility
      \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_html.processHTML.html b/docs/functions/_runtime_util_html.processHTML.html index 687004e..7e73489 100644 --- a/docs/functions/_runtime_util_html.processHTML.html +++ b/docs/functions/_runtime_util_html.processHTML.html @@ -1,13 +1,13 @@ -processHTML | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function processHTML

        • processHTML(
              opts: {
                  containerElement?: string;
                  firstMatchOnly?: boolean;
                  html: string;
                  namespaceURI?: string;
                  process: (HTMLElement: any) => void;
                  selector: string;
              },
          ): 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: any) => void);
                selector: string;
            }

            Options

            -
            • OptionalcontainerElement?: string

              Use a specific container element.

              -
            • OptionalfirstMatchOnly?: boolean

              When true querySelector is invoked to process the +

              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.

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

                  +
                • html: string

                  The HTML to process.

                  +
                • OptionalnamespaceURI?: string

                  The namespace URI of the elements to select.

                  +
                • process: (HTMLElement: any) => void

                  The selected element processing function.

                  +
                • selector: string

                  The CSS selector query.

              Returns string

              The processed HTML.

              -

        Settings

        Member Visibility
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_html_striptags.striptags.html b/docs/functions/_runtime_util_html_striptags.striptags.html index ed506a3..2335968 100644 --- a/docs/functions/_runtime_util_html_striptags.striptags.html +++ b/docs/functions/_runtime_util_html_striptags.striptags.html @@ -1,2 +1,2 @@ -striptags | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function striptags

      Settings

      Member Visibility
      \ No newline at end of file +striptags | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function striptags

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_runtime_util_i18n.localize.html b/docs/functions/_runtime_util_i18n.localize.html index a2808f1..b02ead8 100644 --- a/docs/functions/_runtime_util_i18n.localize.html +++ b/docs/functions/_runtime_util_i18n.localize.html @@ -1,8 +1,8 @@ -localize | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function localize

        • localize(stringId: string, data?: object): 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.

          • Optionaldata: object

            Provided input data.

          Returns string

          The translated and formatted string

          -

        Settings

        Member Visibility
        \ No newline at end of file +

      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 8c92681..f43c349 100644 --- a/docs/functions/_runtime_util_object.deepFreeze.html +++ b/docs/functions/_runtime_util_object.deepFreeze.html @@ -1,6 +1,6 @@ -deepFreeze | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function deepFreeze

      • deepFreeze(data, skipFreezeKeys?): object | []

      • Freezes all entries traversed that are objects including entries in arrays.

        -

        Parameters

        • data: object | []

          An object or array.

          +deepFreeze | TyphonJS Runtime Library (FVTT) 0.2.0
          +

          Function deepFreeze

          • deepFreeze(data: object | [], skipFreezeKeys?: Set<string>): object | []

          • Freezes all entries traversed that are objects including entries in arrays.

            +

            Parameters

            • data: object | []

              An object or array.

            • OptionalskipFreezeKeys: Set<string>

              A Set of strings indicating keys of objects to not freeze.

              -

            Returns object | []

            The frozen object.

            -

          Settings

          Member Visibility
          \ No newline at end of file +

        Returns object | []

        The frozen object.

        +

      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 3741b12..f9d578d 100644 --- a/docs/functions/_runtime_util_object.deepMerge.html +++ b/docs/functions/_runtime_util_object.deepMerge.html @@ -1,8 +1,8 @@ -deepMerge | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function deepMerge

        • deepMerge(target?: object, ...sourceObj: object[]): 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

          • Optionaltarget: object

            Target object.

            -
          • Rest...sourceObj: object[]

            One or more source objects.

            +
          • ...sourceObj: object[]

            One or more source objects.

          Returns object

          Target object.

          -

        Settings

        Member Visibility
        \ 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 714535d..3844c5c 100644 --- a/docs/functions/_runtime_util_object.depthTraverse.html +++ b/docs/functions/_runtime_util_object.depthTraverse.html @@ -1,9 +1,9 @@ -depthTraverse | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function depthTraverse

        • depthTraverse(data: object | [], func: Function, modify?: boolean): 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.

            +

            Parameters

            • data: object | []

              An object or array.

            • func: Function

              A callback function to process leaf values in children arrays or object members.

            • 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
        \ No newline at end of file +

      Returns object | []

      The data object.

      +

      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 8a5f0e7..42afedc 100644 --- a/docs/functions/_runtime_util_object.getAccessorList.html +++ b/docs/functions/_runtime_util_object.getAccessorList.html @@ -1,5 +1,5 @@ -getAccessorList | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getAccessorList

      • getAccessorList(data): string[]

      • Returns a list of accessor keys by traversing the given object.

        +getAccessorList | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function getAccessorList

        • getAccessorList(data: object): 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
        \ 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 d35dab3..c19aedf 100644 --- a/docs/functions/_runtime_util_object.hasAccessor.html +++ b/docs/functions/_runtime_util_object.hasAccessor.html @@ -1,6 +1,6 @@ -hasAccessor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function hasAccessor

        • hasAccessor(object: object, accessor: string): 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
        \ 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 6852ee9..10c1441 100644 --- a/docs/functions/_runtime_util_object.hasGetter.html +++ b/docs/functions/_runtime_util_object.hasGetter.html @@ -1,6 +1,6 @@ -hasGetter | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function hasGetter

        • hasGetter(object: object, accessor: string): 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
        \ 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 e7df63f..b8a1b4a 100644 --- a/docs/functions/_runtime_util_object.hasPrototype.html +++ b/docs/functions/_runtime_util_object.hasPrototype.html @@ -1,6 +1,6 @@ -hasPrototype | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function hasPrototype

        • hasPrototype(target: unknown, Prototype: new (...args: any[]) => any): 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[]) => 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 +
      • Prototype: new (...args: any[]) => any

        Prototype function / class constructor to find.

        +

      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 fc40e5d..05cb9f1 100644 --- a/docs/functions/_runtime_util_object.hasSetter.html +++ b/docs/functions/_runtime_util_object.hasSetter.html @@ -1,6 +1,6 @@ -hasSetter | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function hasSetter

        • hasSetter(object: object, accessor: string): 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
        \ 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 e0cc812..1c00044 100644 --- a/docs/functions/_runtime_util_object.isAsyncIterable.html +++ b/docs/functions/_runtime_util_object.isAsyncIterable.html @@ -1,5 +1,5 @@ -isAsyncIterable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function isAsyncIterable

      Returns value is AsyncIterable<unknown, any, any>

      Whether value is async iterable.

      +

      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 84e9ae9..bc53346 100644 --- a/docs/functions/_runtime_util_object.isIterable.html +++ b/docs/functions/_runtime_util_object.isIterable.html @@ -1,5 +1,5 @@ -isIterable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function isIterable

      Returns value is Iterable<unknown, any, any>

      Whether object is iterable.

      +

      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 3a278c7..3f165b0 100644 --- a/docs/functions/_runtime_util_object.isObject.html +++ b/docs/functions/_runtime_util_object.isObject.html @@ -1,5 +1,5 @@ -isObject | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function isObject

        • isObject(value: unknown): 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
        \ No newline at end of file +

      Returns value is Record<string, unknown>

      Is it an object.

      +

      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 d2b4977..d4628de 100644 --- a/docs/functions/_runtime_util_object.isPlainObject.html +++ b/docs/functions/_runtime_util_object.isPlainObject.html @@ -1,6 +1,6 @@ -isPlainObject | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function isPlainObject

      Returns value is JSONObject

      Is it a plain object.

      +

      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 0e7be4a..64807c0 100644 --- a/docs/functions/_runtime_util_object.klona.html +++ b/docs/functions/_runtime_util_object.klona.html @@ -1,2 +1,2 @@ -klona | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function klona

      • klona<T>(input): T

      • Type Parameters

        • T

        Parameters

        • input: T

        Returns T

      Settings

      Member Visibility
      \ No newline at end of file +klona | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function klona

      • klona<T>(input: T): 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 0b0510e..a7095d1 100644 --- a/docs/functions/_runtime_util_object.objectKeys.html +++ b/docs/functions/_runtime_util_object.objectKeys.html @@ -1,5 +1,5 @@ -objectKeys | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function objectKeys

        • objectKeys(object: 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
        \ 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 febf9ce..3f1f4e7 100644 --- a/docs/functions/_runtime_util_object.objectSize.html +++ b/docs/functions/_runtime_util_object.objectSize.html @@ -1,5 +1,5 @@ -objectSize | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function objectSize

        • objectSize(object: any): 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
        \ 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 e128b21..702ca92 100644 --- a/docs/functions/_runtime_util_object.safeAccess.html +++ b/docs/functions/_runtime_util_object.safeAccess.html @@ -1,9 +1,9 @@ -safeAccess | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function safeAccess

        • safeAccess(data: object, accessor: string, defaultValue?: any): 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 ..

          • OptionaldefaultValue: any

            (Optional) A default value to return if an entry for accessor is not found.

          Returns any

          The data object.

          -

        Settings

        Member Visibility
        \ 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 6dab7ed..911c46d 100644 --- a/docs/functions/_runtime_util_object.safeBatchSet.html +++ b/docs/functions/_runtime_util_object.safeBatchSet.html @@ -1,5 +1,5 @@ -safeBatchSet | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function safeBatchSet

        • safeBatchSet(
              data: object,
              accessors: string[],
              value: any,
              operation?: SafeSetOperation,
              defaultAccessValue?: any,
              createMissing?: boolean,
          ): 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 @@ -11,4 +11,4 @@ '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 +

      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 b09b1bb..dc91aac 100644 --- a/docs/functions/_runtime_util_object.safeEqual.html +++ b/docs/functions/_runtime_util_object.safeEqual.html @@ -1,8 +1,8 @@ -safeEqual | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function safeEqual

        • safeEqual(source: object, target: object): 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
        \ 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 d376391..59ca3d9 100644 --- a/docs/functions/_runtime_util_object.safeSet.html +++ b/docs/functions/_runtime_util_object.safeSet.html @@ -1,5 +1,5 @@ -safeSet | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function safeSet

        • safeSet(
              data: object,
              accessor: string,
              value: any,
              operation?: SafeSetOperation,
              createMissing?: boolean,
          ): 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.

            @@ -10,4 +10,4 @@
          • OptionalcreateMissing: boolean

            If true missing accessor entries will be created as objects automatically.

          Returns boolean

          True if successful.

          -

        Settings

        Member Visibility
        \ 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 1c75fee..77af6e3 100644 --- a/docs/functions/_runtime_util_object.safeSetAll.html +++ b/docs/functions/_runtime_util_object.safeSetAll.html @@ -1,9 +1,9 @@ -safeSetAll | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function safeSetAll

        • safeSetAll(
              data: object,
              accessorValues: Record<string, any>,
              operation?: SafeSetOperation,
              createMissing?: boolean,
          ): 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.

            +
          • accessorValues: Record<string, any>

            Object of accessor keys to values to set.

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

      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 fbbf667..74d4049 100644 --- a/docs/functions/_runtime_util_object.validate.html +++ b/docs/functions/_runtime_util_object.validate.html @@ -1,7 +1,7 @@ -validate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function validate

        • validate(
              data: object,
              validationData?: Record<string, ValidationEntry>,
              dataName?: string,
          ): any

        • Performs bulk validation of data given an object, validationData, which describes all entries to test.

          Parameters

          • data: object

            The data object to test.

            -
          • OptionalvalidationData: Record<string, ValidationEntry>

            Key is the accessor / value is a validation entry.

            +
          • 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
        \ 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 89df618..346c089 100644 --- a/docs/functions/_runtime_util_object.validateArray.html +++ b/docs/functions/_runtime_util_object.validateArray.html @@ -1,8 +1,8 @@ -validateArray | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function validateArray

        • validateArray(
              data: object,
              accessor: string,
              entry: ValidationEntry,
              dataName?: string,
          ): 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

          • OptionaldataName: string

            Optional name of data.

          Returns boolean

          True if validation passes otherwise an exception is thrown.

          -

        Settings

        Member Visibility
        \ 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 b98a141..c94a844 100644 --- a/docs/functions/_runtime_util_object.validateEntry.html +++ b/docs/functions/_runtime_util_object.validateEntry.html @@ -1,8 +1,8 @@ -validateEntry | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function validateEntry

        • validateEntry(
              data: object,
              accessor: string,
              entry: ValidationEntry,
              dataName?: string,
          ): 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.

          • OptionaldataName: string

            Optional name of data.

          Returns boolean

          True if validation passes otherwise an exception is thrown.

          -

        Settings

        Member Visibility
        \ 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 378dca7..d7a21c7 100644 --- a/docs/functions/_runtime_util_object.validateEntryOrArray.html +++ b/docs/functions/_runtime_util_object.validateEntryOrArray.html @@ -1,8 +1,8 @@ -validateEntryOrArray | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
        +

        Function validateEntryOrArray

        • validateEntryOrArray(
              data: object,
              accessor: string,
              entry?: ValidationEntry,
              dataName?: string,
          ): 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.

          • 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
        \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_standard_action_animate_composable.animateWAAPI.html b/docs/functions/_standard_action_animate_composable.animateWAAPI.html index e8c3540..c729a43 100644 --- a/docs/functions/_standard_action_animate_composable.animateWAAPI.html +++ b/docs/functions/_standard_action_animate_composable.animateWAAPI.html @@ -1,11 +1,11 @@ -animateWAAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function animateWAAPI

      Settings

      Member Visibility
      \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_standard_action_animate_composable.composable.html b/docs/functions/_standard_action_animate_composable.composable.html index eb34745..7996468 100644 --- a/docs/functions/_standard_action_animate_composable.composable.html +++ b/docs/functions/_standard_action_animate_composable.composable.html @@ -1,7 +1,7 @@ -composable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function composable

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_standard_action_animate_composable.ripple.html b/docs/functions/_standard_action_animate_composable.ripple.html index 62acd83..7b25314 100644 --- a/docs/functions/_standard_action_animate_composable.ripple.html +++ b/docs/functions/_standard_action_animate_composable.ripple.html @@ -1,5 +1,5 @@ -ripple | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function ripple

      • ripple(opts?): Action<HTMLElement, ActionReturn<Ripple>>

      • 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

        +

        Function ripple

        • ripple(
              opts?: {
                  background?: string;
                  contextmenu?: boolean;
                  debounce?: number;
                  duration?: number;
                  enabled?: boolean;
                  events?: Iterable<string, any, any>;
                  keyCode?: string;
              },
          ): Action<HTMLElement, ActionReturn<Ripple>>

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

          @@ -8,14 +8,14 @@

          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

          • Optionalopts: {
                background?: string;
                contextmenu?: boolean;
                debounce?: number;
                duration?: number;
                enabled?: boolean;
                events?: Iterable<string, any, any>;
                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.

              -
            • Optionalenabled?: boolean

              Enabled state.

              -
            • Optionalevents?: Iterable<string, any, any>

              DOM event to bind element to respond with the ripple +

              Parameters

              • Optionalopts: {
                    background?: string;
                    contextmenu?: boolean;
                    debounce?: number;
                    duration?: number;
                    enabled?: boolean;
                    events?: Iterable<string, any, any>;
                    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.

                  +
                • Optionalenabled?: boolean

                  Enabled state.

                  +
                • Optionalevents?: Iterable<string, any, any>

                  DOM event to bind element to respond with the ripple effect.

                  -
                • OptionalkeyCode?: string

                  Key code to trigger for any applicable key events.

                  -

              Returns Action<HTMLElement, ActionReturn<Ripple>>

              Actual ripple Action.

              -

        Settings

        Member Visibility
        \ No newline at end of file +
      • OptionalkeyCode?: string

        Key code to trigger for any applicable key events.

        +

      Returns Action<HTMLElement, ActionReturn<Ripple>>

      Actual ripple Action.

      +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/_standard_action_animate_composable.rippleFocus.html b/docs/functions/_standard_action_animate_composable.rippleFocus.html index 4d627f1..21c1521 100644 --- a/docs/functions/_standard_action_animate_composable.rippleFocus.html +++ b/docs/functions/_standard_action_animate_composable.rippleFocus.html @@ -1,5 +1,5 @@ -rippleFocus | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function rippleFocus

      • rippleFocus(opts?): Action<HTMLElement, ActionReturn<RippleFocus>>

      • 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

        +

        Function rippleFocus

        • rippleFocus(
              opts?: {
                  background?: string;
                  duration?: number;
                  enabled?: boolean;
                  selector?: string;
              },
          ): Action<HTMLElement, ActionReturn<RippleFocus>>

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

          @@ -9,10 +9,10 @@ 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

          • Optionalopts: {
                background?: string;
                duration?: number;
                enabled?: boolean;
                selector?: string;
            }

            Optional parameters.

            -
            • Optionalbackground?: string

              A valid CSS background attribute.

              -
            • Optionalduration?: number

              Duration in milliseconds.

              -
            • Optionalenabled?: boolean

              Enabled state.

              -
            • Optionalselector?: string

              A valid CSS selector string.

              -

          Returns Action<HTMLElement, ActionReturn<RippleFocus>>

          Actual rippleFocus Action.

          -

        Settings

        Member Visibility
        \ No newline at end of file +

        Parameters

        • Optionalopts: { background?: string; duration?: number; enabled?: boolean; selector?: string }

          Optional parameters.

          +
          • Optionalbackground?: string

            A valid CSS background attribute.

            +
          • Optionalduration?: number

            Duration in milliseconds.

            +
          • Optionalenabled?: boolean

            Enabled state.

            +
          • Optionalselector?: string

            A valid CSS selector string.

            +

        Returns Action<HTMLElement, ActionReturn<RippleFocus>>

        Actual rippleFocus Action.

        +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/svelte.afterUpdate.html b/docs/functions/svelte.afterUpdate.html index 648abf0..4d53455 100644 --- a/docs/functions/svelte.afterUpdate.html +++ b/docs/functions/svelte.afterUpdate.html @@ -1,5 +1,5 @@ -afterUpdate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function afterUpdate

      • afterUpdate(fn): void

      • Schedules a callback to run immediately after the component has been updated.

        +afterUpdate | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function afterUpdate

        • afterUpdate(fn: () => any): void

        • Schedules a callback to run immediately after the component has been updated.

          The first time the callback runs will be after the initial onMount

          https://svelte.dev/docs/svelte#afterupdate

          -

          Parameters

          • fn: (() => any)
              • (): any

              • Returns any

          Returns void

        Settings

        Member Visibility
        \ No newline at end of file +

        Parameters

        • fn: () => any

        Returns void

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/svelte.beforeUpdate.html b/docs/functions/svelte.beforeUpdate.html index de80186..1ea0435 100644 --- a/docs/functions/svelte.beforeUpdate.html +++ b/docs/functions/svelte.beforeUpdate.html @@ -1,5 +1,5 @@ -beforeUpdate | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function beforeUpdate

      • beforeUpdate(fn): void

      • Schedules a callback to run immediately before the component is updated after any state change.

        +beforeUpdate | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function beforeUpdate

        • beforeUpdate(fn: () => any): void

        • Schedules a callback to run immediately before the component is updated after any state change.

          The first time the callback runs will be before the initial onMount

          https://svelte.dev/docs/svelte#beforeupdate

          -

          Parameters

          • fn: (() => any)
              • (): any

              • Returns any

          Returns void

        Settings

        Member Visibility
        \ No newline at end of file +

        Parameters

        • fn: () => any

        Returns void

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/svelte.createEventDispatcher.html b/docs/functions/svelte.createEventDispatcher.html index 652d46f..d0875db 100644 --- a/docs/functions/svelte.createEventDispatcher.html +++ b/docs/functions/svelte.createEventDispatcher.html @@ -1,5 +1,5 @@ -createEventDispatcher | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 4e29b35..bd75743 100644 --- a/docs/functions/svelte.getAllContexts.html +++ b/docs/functions/svelte.getAllContexts.html @@ -1,6 +1,6 @@ -getAllContexts | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getAllContexts

      • getAllContexts<T>(): T

      • Retrieves the whole context map that belongs to the closest parent component. +getAllContexts | TyphonJS Runtime Library (FVTT) 0.2.0

        +

        Function getAllContexts

        • getAllContexts<T extends Map<any, any> = Map<any, any>>(): T

        • Retrieves the whole context map that belongs to the closest parent component. Must be called during component initialisation. Useful, for example, if you programmatically create a component and want to pass the existing context to it.

          https://svelte.dev/docs/svelte#getallcontexts

          -

          Type Parameters

          • T extends Map<any, any> = Map<any, any>

          Returns T

        Settings

        Member Visibility
        \ No newline at end of file +

        Type Parameters

        • T extends Map<any, any> = Map<any, any>

        Returns T

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/svelte.getContext.html b/docs/functions/svelte.getContext.html index 8133952..8205273 100644 --- a/docs/functions/svelte.getContext.html +++ b/docs/functions/svelte.getContext.html @@ -1,5 +1,5 @@ -getContext | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function getContext

      • getContext<T>(key): T

      • Retrieves the context that belongs to the closest parent component with the specified key. +getContext | TyphonJS Runtime Library (FVTT) 0.2.0

        +

        Function getContext

        • getContext<T>(key: any): T

        • 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

          -

          Type Parameters

          • T

          Parameters

          • key: any

          Returns T

        Settings

        Member Visibility
        \ No newline at end of file +

        Type Parameters

        • T

        Parameters

        • key: any

        Returns T

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/svelte.hasContext.html b/docs/functions/svelte.hasContext.html index 0db4690..4d6c34b 100644 --- a/docs/functions/svelte.hasContext.html +++ b/docs/functions/svelte.hasContext.html @@ -1,5 +1,5 @@ -hasContext | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 7fca31a..0068f03 100644 --- a/docs/functions/svelte.onDestroy.html +++ b/docs/functions/svelte.onDestroy.html @@ -1,6 +1,6 @@ -onDestroy | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function onDestroy

      • onDestroy(fn): void

      • Schedules a callback to run immediately before the component is unmounted.

        +onDestroy | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function onDestroy

        • onDestroy(fn: () => any): void

        • 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

          -

          Parameters

          • fn: (() => any)
              • (): any

              • Returns any

          Returns void

        Settings

        Member Visibility
        \ No newline at end of file +

        Parameters

        • fn: () => any

        Returns void

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/functions/svelte.onMount.html b/docs/functions/svelte.onMount.html index 11eb6a5..71cfc1f 100644 --- a/docs/functions/svelte.onMount.html +++ b/docs/functions/svelte.onMount.html @@ -1,8 +1,8 @@ -onMount | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 913b1c1..944ecf0 100644 --- a/docs/functions/svelte.setContext.html +++ b/docs/functions/svelte.setContext.html @@ -1,7 +1,7 @@ -setContext | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

        +

        Function setContext

        • setContext<T>(key: any, context: T): 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
        \ No newline at end of file +

        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 a62291f..690c834 100644 --- a/docs/functions/svelte.tick.html +++ b/docs/functions/svelte.tick.html @@ -1,2 +1,2 @@ -tick | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function tick

      Settings

      Member Visibility
      \ No newline at end of file +tick | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 7d39232..827c81d 100644 --- a/docs/functions/svelte_animate.flip.html +++ b/docs/functions/svelte_animate.flip.html @@ -1,5 +1,5 @@ -flip | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 f490514..8f206a4 100644 --- a/docs/functions/svelte_easing.backIn.html +++ b/docs/functions/svelte_easing.backIn.html @@ -1,3 +1,3 @@ -backIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function backIn

      Settings

      Member Visibility
      \ No newline at end of file +backIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 ac9e346..26468b1 100644 --- a/docs/functions/svelte_easing.backInOut.html +++ b/docs/functions/svelte_easing.backInOut.html @@ -1,3 +1,3 @@ -backInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function backInOut

      Settings

      Member Visibility
      \ No newline at end of file +backInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 925d676..d5a1cfa 100644 --- a/docs/functions/svelte_easing.backOut.html +++ b/docs/functions/svelte_easing.backOut.html @@ -1,3 +1,3 @@ -backOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function backOut

      Settings

      Member Visibility
      \ No newline at end of file +backOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 9a70f2a..ed5025c 100644 --- a/docs/functions/svelte_easing.bounceIn.html +++ b/docs/functions/svelte_easing.bounceIn.html @@ -1,3 +1,3 @@ -bounceIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function bounceIn

      Settings

      Member Visibility
      \ No newline at end of file +bounceIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 60efee2..11a9f1a 100644 --- a/docs/functions/svelte_easing.bounceInOut.html +++ b/docs/functions/svelte_easing.bounceInOut.html @@ -1,3 +1,3 @@ -bounceInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function bounceInOut

      Settings

      Member Visibility
      \ No newline at end of file +bounceInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 ec6d9de..18ee1f0 100644 --- a/docs/functions/svelte_easing.bounceOut.html +++ b/docs/functions/svelte_easing.bounceOut.html @@ -1,3 +1,3 @@ -bounceOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function bounceOut

      Settings

      Member Visibility
      \ No newline at end of file +bounceOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 3cdedb8..c313f15 100644 --- a/docs/functions/svelte_easing.circIn.html +++ b/docs/functions/svelte_easing.circIn.html @@ -1,3 +1,3 @@ -circIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function circIn

      Settings

      Member Visibility
      \ No newline at end of file +circIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 6c6b3de..60a68b5 100644 --- a/docs/functions/svelte_easing.circInOut.html +++ b/docs/functions/svelte_easing.circInOut.html @@ -1,3 +1,3 @@ -circInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function circInOut

      Settings

      Member Visibility
      \ No newline at end of file +circInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 05ac86d..4edc72f 100644 --- a/docs/functions/svelte_easing.circOut.html +++ b/docs/functions/svelte_easing.circOut.html @@ -1,3 +1,3 @@ -circOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function circOut

      Settings

      Member Visibility
      \ No newline at end of file +circOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 99a7e5c..2c57fe6 100644 --- a/docs/functions/svelte_easing.cubicIn.html +++ b/docs/functions/svelte_easing.cubicIn.html @@ -1,3 +1,3 @@ -cubicIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function cubicIn

      Settings

      Member Visibility
      \ No newline at end of file +cubicIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 2a7a75b..6d8fbcd 100644 --- a/docs/functions/svelte_easing.cubicInOut.html +++ b/docs/functions/svelte_easing.cubicInOut.html @@ -1,3 +1,3 @@ -cubicInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function cubicInOut

      Settings

      Member Visibility
      \ No newline at end of file +cubicInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 641ea8b..a9102d2 100644 --- a/docs/functions/svelte_easing.cubicOut.html +++ b/docs/functions/svelte_easing.cubicOut.html @@ -1,3 +1,3 @@ -cubicOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function cubicOut

      Settings

      Member Visibility
      \ No newline at end of file +cubicOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 deca3a6..f0f3c62 100644 --- a/docs/functions/svelte_easing.elasticIn.html +++ b/docs/functions/svelte_easing.elasticIn.html @@ -1,3 +1,3 @@ -elasticIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function elasticIn

      Settings

      Member Visibility
      \ No newline at end of file +elasticIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 bca8a04..0eabc3e 100644 --- a/docs/functions/svelte_easing.elasticInOut.html +++ b/docs/functions/svelte_easing.elasticInOut.html @@ -1,3 +1,3 @@ -elasticInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function elasticInOut

      Settings

      Member Visibility
      \ No newline at end of file +elasticInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 6bf8616..65b499d 100644 --- a/docs/functions/svelte_easing.elasticOut.html +++ b/docs/functions/svelte_easing.elasticOut.html @@ -1,3 +1,3 @@ -elasticOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function elasticOut

      Settings

      Member Visibility
      \ No newline at end of file +elasticOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 8d03516..55fac9c 100644 --- a/docs/functions/svelte_easing.expoIn.html +++ b/docs/functions/svelte_easing.expoIn.html @@ -1,3 +1,3 @@ -expoIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function expoIn

      Settings

      Member Visibility
      \ No newline at end of file +expoIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 6aaea36..e8eb09f 100644 --- a/docs/functions/svelte_easing.expoInOut.html +++ b/docs/functions/svelte_easing.expoInOut.html @@ -1,3 +1,3 @@ -expoInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function expoInOut

      Settings

      Member Visibility
      \ No newline at end of file +expoInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 add6b86..3b19cc4 100644 --- a/docs/functions/svelte_easing.expoOut.html +++ b/docs/functions/svelte_easing.expoOut.html @@ -1,3 +1,3 @@ -expoOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function expoOut

      Settings

      Member Visibility
      \ No newline at end of file +expoOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 03037b6..feb0475 100644 --- a/docs/functions/svelte_easing.linear.html +++ b/docs/functions/svelte_easing.linear.html @@ -1,2 +1,2 @@ -linear | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function linear

      • linear(x): any

      • Parameters

        • x: any

        Returns any

      Settings

      Member Visibility
      \ No newline at end of file +linear | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Function linear

      • linear(x: any): 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 33a5eb5..d12e54d 100644 --- a/docs/functions/svelte_easing.quadIn.html +++ b/docs/functions/svelte_easing.quadIn.html @@ -1,3 +1,3 @@ -quadIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quadIn

      Settings

      Member Visibility
      \ No newline at end of file +quadIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 f00c575..7eb1877 100644 --- a/docs/functions/svelte_easing.quadInOut.html +++ b/docs/functions/svelte_easing.quadInOut.html @@ -1,3 +1,3 @@ -quadInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quadInOut

      Settings

      Member Visibility
      \ No newline at end of file +quadInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 04f779c..275a105 100644 --- a/docs/functions/svelte_easing.quadOut.html +++ b/docs/functions/svelte_easing.quadOut.html @@ -1,3 +1,3 @@ -quadOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quadOut

      Settings

      Member Visibility
      \ No newline at end of file +quadOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 e0ff327..754194a 100644 --- a/docs/functions/svelte_easing.quartIn.html +++ b/docs/functions/svelte_easing.quartIn.html @@ -1,3 +1,3 @@ -quartIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quartIn

      Settings

      Member Visibility
      \ No newline at end of file +quartIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 f0db49f..f2b96b2 100644 --- a/docs/functions/svelte_easing.quartInOut.html +++ b/docs/functions/svelte_easing.quartInOut.html @@ -1,3 +1,3 @@ -quartInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quartInOut

      Settings

      Member Visibility
      \ No newline at end of file +quartInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 e21ed73..f967e84 100644 --- a/docs/functions/svelte_easing.quartOut.html +++ b/docs/functions/svelte_easing.quartOut.html @@ -1,3 +1,3 @@ -quartOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quartOut

      Settings

      Member Visibility
      \ No newline at end of file +quartOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 9a47d2b..8ffe9b5 100644 --- a/docs/functions/svelte_easing.quintIn.html +++ b/docs/functions/svelte_easing.quintIn.html @@ -1,3 +1,3 @@ -quintIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quintIn

      Settings

      Member Visibility
      \ No newline at end of file +quintIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 35e1d7f..3615237 100644 --- a/docs/functions/svelte_easing.quintInOut.html +++ b/docs/functions/svelte_easing.quintInOut.html @@ -1,3 +1,3 @@ -quintInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quintInOut

      Settings

      Member Visibility
      \ No newline at end of file +quintInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 7abfd0d..ebfc6da 100644 --- a/docs/functions/svelte_easing.quintOut.html +++ b/docs/functions/svelte_easing.quintOut.html @@ -1,3 +1,3 @@ -quintOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function quintOut

      Settings

      Member Visibility
      \ No newline at end of file +quintOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 6fd31ff..7707228 100644 --- a/docs/functions/svelte_easing.sineIn.html +++ b/docs/functions/svelte_easing.sineIn.html @@ -1,3 +1,3 @@ -sineIn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function sineIn

      Settings

      Member Visibility
      \ No newline at end of file +sineIn | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 719ae96..cb8421d 100644 --- a/docs/functions/svelte_easing.sineInOut.html +++ b/docs/functions/svelte_easing.sineInOut.html @@ -1,3 +1,3 @@ -sineInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function sineInOut

      Settings

      Member Visibility
      \ No newline at end of file +sineInOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 f3bbd2e..83ccf79 100644 --- a/docs/functions/svelte_easing.sineOut.html +++ b/docs/functions/svelte_easing.sineOut.html @@ -1,3 +1,3 @@ -sineOut | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function sineOut

      Settings

      Member Visibility
      \ No newline at end of file +sineOut | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 63b5e14..2b4dfd8 100644 --- a/docs/functions/svelte_motion.spring.html +++ b/docs/functions/svelte_motion.spring.html @@ -1,4 +1,4 @@ -spring | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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.

        +spring | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function spring

        • spring<T = any>(value?: T, opts?: SpringOpts): 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 +

        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 87f56ad..e5f05de 100644 --- a/docs/functions/svelte_motion.tweened.html +++ b/docs/functions/svelte_motion.tweened.html @@ -1,4 +1,4 @@ -tweened | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 312f98b..739c1c8 100644 --- a/docs/functions/svelte_store.derived.html +++ b/docs/functions/svelte_store.derived.html @@ -1,8 +1,8 @@ -derived | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 6b88f07..67d2b17 100644 --- a/docs/functions/svelte_store.get.html +++ b/docs/functions/svelte_store.get.html @@ -1,4 +1,4 @@ -get | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 50ae094..facbfef 100644 --- a/docs/functions/svelte_store.readable.html +++ b/docs/functions/svelte_store.readable.html @@ -1,5 +1,5 @@ -readable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 6b24f67..a39d595 100644 --- a/docs/functions/svelte_store.readonly.html +++ b/docs/functions/svelte_store.readonly.html @@ -1,5 +1,5 @@ -readonly | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function readonly

      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 3466f94..c481a4e 100644 --- a/docs/functions/svelte_store.writable.html +++ b/docs/functions/svelte_store.writable.html @@ -1,5 +1,5 @@ -writable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 fa970d8..5c2c01f 100644 --- a/docs/functions/svelte_transition.blur.html +++ b/docs/functions/svelte_transition.blur.html @@ -1,4 +1,4 @@ -blur | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 36a2c91..89fde41 100644 --- a/docs/functions/svelte_transition.crossfade.html +++ b/docs/functions/svelte_transition.crossfade.html @@ -1,4 +1,4 @@ -crossfade | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 2770275..8659dfa 100644 --- a/docs/functions/svelte_transition.draw.html +++ b/docs/functions/svelte_transition.draw.html @@ -1,4 +1,4 @@ -draw | TyphonJS Runtime Library (FVTT) 0.2.0
      -

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

        +draw | TyphonJS Runtime Library (FVTT) 0.2.0
        +

        Function draw

        • draw(
              node: SVGElement & { getTotalLength(): number },
              __namedParameters?: DrawParams,
          ): 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 +

        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 8f30a5f..06bbf4e 100644 --- a/docs/functions/svelte_transition.fade.html +++ b/docs/functions/svelte_transition.fade.html @@ -1,4 +1,4 @@ -fade | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 a17c9f7..da23b50 100644 --- a/docs/functions/svelte_transition.fly.html +++ b/docs/functions/svelte_transition.fly.html @@ -1,4 +1,4 @@ -fly | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 689529b..653fc0b 100644 --- a/docs/functions/svelte_transition.scale.html +++ b/docs/functions/svelte_transition.scale.html @@ -1,4 +1,4 @@ -scale | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 ffe3b93..18514b9 100644 --- a/docs/functions/svelte_transition.slide.html +++ b/docs/functions/svelte_transition.slide.html @@ -1,4 +1,4 @@ -slide | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Function slide

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/hierarchy.html b/docs/hierarchy.html index fd88419..44528b4 100644 --- a/docs/hierarchy.html +++ b/docs/hierarchy.html @@ -1,2 +1,2 @@ -TyphonJS Runtime Library (FVTT) 0.2.0
      -

      TyphonJS Runtime Library (FVTT) 0.2.0

      Class Hierarchy

      Settings

      Member Visibility
      \ No newline at end of file +TyphonJS Runtime Library (FVTT) 0.2.0
      +

      TyphonJS Runtime Library (FVTT) 0.2.0

      Hierarchy Summary

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index ca81263..626d3fe 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,5 +1,5 @@ -TyphonJS Runtime Library (FVTT) 0.2.0
      -

      TyphonJS Runtime Library (FVTT) 0.2.0

      The TyphonJS Runtime Library (TRL) is an integrated library and framework for creating modern Svelte powered packages +TyphonJS Runtime Library (FVTT) 0.2.0

      +

      TyphonJS Runtime Library (FVTT) 0.2.0

      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 tabletop.

      There are many useful libraries and original code brought together that extend the power of Svelte to provide a cohesive modern runtime library for advanced package development. Some of the highlights are an optimized and reactive @@ -11,4 +11,4 @@

      The API docs are available here: https://typhonjs-fvtt-lib.github.io/api-docs

      A demo repo / package (requires Foundry VTT) is available here: https://github.com/typhonjs-fvtt-demo

      -

      Settings

      Member Visibility
      \ No newline at end of file +

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_color_colord.LabColor.html b/docs/interfaces/_runtime_data_color_colord.LabColor.html index f2ebcca..897daeb 100644 --- a/docs/interfaces/_runtime_data_color_colord.LabColor.html +++ b/docs/interfaces/_runtime_data_color_colord.LabColor.html @@ -1,5 +1,5 @@ -LabColor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface LabColor

      interface LabColor {
          a: number;
          b: number;
          l: number;
      }

      Properties

      a +LabColor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      On This Page

      Properties
      \ 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_data_color_colord.LchColor.html b/docs/interfaces/_runtime_data_color_colord.LchColor.html index 0341b6d..3e8933b 100644 --- a/docs/interfaces/_runtime_data_color_colord.LchColor.html +++ b/docs/interfaces/_runtime_data_color_colord.LchColor.html @@ -1,5 +1,5 @@ -LchColor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface LchColor

      interface LchColor {
          c: number;
          h: number;
          l: number;
      }

      Properties

      c +LchColor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      On This Page

      Properties
      \ 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_data_color_colord.XyzColor.html b/docs/interfaces/_runtime_data_color_colord.XyzColor.html index e03304d..d93798e 100644 --- a/docs/interfaces/_runtime_data_color_colord.XyzColor.html +++ b/docs/interfaces/_runtime_data_color_colord.XyzColor.html @@ -1,5 +1,5 @@ -XyzColor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface XyzColor

      interface XyzColor {
          x: number;
          y: number;
          z: number;
      }

      Properties

      x +XyzColor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      On This Page

      Properties
      \ 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 9e44d31..a59208a 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncDeflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncDeflateOptions.html @@ -1,6 +1,6 @@ -AsyncDeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +AsyncDeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncDeflateOptions

      Options for compressing data asynchronously into a DEFLATE format

      +
      interface AsyncDeflateOptions {
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
          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;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      consume? dictionary? @@ -16,12 +16,12 @@
      mem?

      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.

      -

      Optionaldictionary

      dictionary?: Uint8Array

      A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

      +

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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.

      -

      Optionallevel

      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.

      @@ -33,9 +33,9 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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

      On This Page

      Properties
      \ 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 8cafb5f..b659333 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncGunzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncGunzipOptions.html @@ -1,6 +1,6 @@ -AsyncGunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface AsyncGunzipOptions

      Options for decompressing GZIP data asynchronously

      -
      interface AsyncGunzipOptions {
          consume?: boolean;
          dictionary?: Uint8Array;
      }
      +AsyncGunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncGunzipOptions

      Options for decompressing GZIP data asynchronously

      +
      interface AsyncGunzipOptions {
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,12 +8,12 @@
      Hierarchy
      -
      +

      Properties

      consume? dictionary?

      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.

      -

      Optionaldictionary

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

      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

      On This Page

      Properties
      \ 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 0f4e596..e27febf 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncGzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncGzipOptions.html @@ -1,6 +1,6 @@ -AsyncGzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +AsyncGzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncGzipOptions

      Options for compressing data asynchronously into a GZIP format

      +
      interface AsyncGzipOptions {
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
          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;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      consume? dictionary? @@ -18,14 +18,14 @@
      mtime?

      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.

      -

      Optionaldictionary

      dictionary?: Uint8Array

      A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

      +

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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.

      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.

      -

      Optionallevel

      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.

      @@ -37,11 +37,11 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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.

      -

      Optionalmtime

      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

      On This Page

      Properties
      \ 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 72bd34e..16b7a9b 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncInflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncInflateOptions.html @@ -1,6 +1,6 @@ -AsyncInflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface AsyncInflateOptions

      Options for decompressing DEFLATE data asynchronously

      -
      interface AsyncInflateOptions {
          consume?: boolean;
          dictionary?: Uint8Array;
          size?: number;
      }
      +AsyncInflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncInflateOptions

      Options for decompressing DEFLATE data asynchronously

      +
      interface AsyncInflateOptions {
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
          size?: number;
      }
      @@ -8,16 +8,16 @@
      Hierarchy
      -
      +

      Properties

      consume? dictionary? size?

      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.

      -

      Optionaldictionary

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

      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.

      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

      On This Page

      Properties
      \ 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 61e2d54..8943283 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncTerminable.html +++ b/docs/interfaces/_runtime_data_compress.AsyncTerminable.html @@ -1,4 +1,4 @@ -AsyncTerminable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +AsyncTerminable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 4d3ac5a..7d42b5e 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncUnzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncUnzipOptions.html @@ -1,6 +1,6 @@ -AsyncUnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface AsyncUnzipOptions

      Options for asynchronously expanding a ZIP archive

      -
      interface AsyncUnzipOptions {
          filter?: UnzipFileFilter;
      }
      +AsyncUnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncUnzipOptions

      Options for asynchronously expanding a ZIP archive

      +
      interface AsyncUnzipOptions {
          filter?: UnzipFileFilter;
      }
      @@ -8,8 +8,8 @@
      Hierarchy
      -
      +

      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 +

      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 b28d77f..98d94ad 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncUnzlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncUnzlibOptions.html @@ -1,6 +1,6 @@ -AsyncUnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface AsyncUnzlibOptions

      Options for decompressing Zlib data asynchronously

      -
      interface AsyncUnzlibOptions {
          consume?: boolean;
          dictionary?: Uint8Array;
          size?: number;
      }
      +AsyncUnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncUnzlibOptions

      Options for decompressing Zlib data asynchronously

      +
      interface AsyncUnzlibOptions {
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
          size?: number;
      }
      @@ -8,16 +8,16 @@
      Hierarchy
      -
      +

      Properties

      consume? dictionary? size?

      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.

      -

      Optionaldictionary

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

      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.

      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

      On This Page

      Properties
      \ 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 7a91d91..928319a 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncZipOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncZipOptions.html @@ -1,6 +1,6 @@ -AsyncZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +AsyncZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncZipOptions

      Options for asynchronously creating a ZIP archive

      +
      interface AsyncZipOptions {
          attrs?: number;
          comment?: string;
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
          extra?: Record<number, Uint8Array<ArrayBufferLike>>;
          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;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      attrs? comment? @@ -36,17 +36,17 @@
      field is not read by consumer software.

      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.

      -

      Optionaldictionary

      dictionary?: Uint8Array

      A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

      +

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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.

      -

      Optionalextra

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

      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.

      -

      Optionallevel

      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.

      @@ -58,13 +58,13 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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.

      -

      Optionalmtime

      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.

      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

      On This Page

      Properties
      \ 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 ed353a7..fa01ae3 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncZippable.html +++ b/docs/interfaces/_runtime_data_compress.AsyncZippable.html @@ -1,3 +1,3 @@ -AsyncZippable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface AsyncZippable

      The complete directory structure of an asynchronously ZIPpable archive

      -

      Indexable

      Settings

      Member Visibility
      \ No newline at end of file +AsyncZippable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 f01d857..52dcaa5 100644 --- a/docs/interfaces/_runtime_data_compress.AsyncZlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.AsyncZlibOptions.html @@ -1,6 +1,6 @@ -AsyncZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +AsyncZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AsyncZlibOptions

      Options for compressing data asynchronously into a Zlib format

      +
      interface AsyncZlibOptions {
          consume?: boolean;
          dictionary?: Uint8Array<ArrayBufferLike>;
          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;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      consume? dictionary? @@ -16,12 +16,12 @@
      mem?

      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.

      -

      Optionaldictionary

      dictionary?: Uint8Array

      A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

      +

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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.

      -

      Optionallevel

      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.

      @@ -33,9 +33,9 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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

      On This Page

      Properties
      \ 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 8e37d74..69ada09 100644 --- a/docs/interfaces/_runtime_data_compress.DeflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.DeflateOptions.html @@ -1,6 +1,6 @@ -DeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +DeflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DeflateOptions

      Options for compressing data into a DEFLATE format

      +
      interface DeflateOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
          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;
      }
      @@ -8,17 +8,17 @@
      Hierarchy
      -
      +

      Properties

      dictionary? level? mem? -

      Properties

      Optionaldictionary

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

      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.

      -

      Optionallevel

      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.

      @@ -30,9 +30,9 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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

      On This Page

      Properties
      \ 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 e4f21ac..5309334 100644 --- a/docs/interfaces/_runtime_data_compress.FlateError.html +++ b/docs/interfaces/_runtime_data_compress.FlateError.html @@ -1,6 +1,6 @@ -FlateError | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface FlateError

      An error generated within this library

      -
      interface FlateError {
          cause?: unknown;
          code: number;
          message: string;
          name: string;
          stack?: string;
      }
      +FlateError | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface FlateError

      An error generated within this library

      +
      interface FlateError {
          cause?: unknown;
          code: number;
          message: string;
          name: string;
          stack?: string;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      cause? code @@ -16,4 +16,4 @@
      name stack?

      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 +

      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 f9c4901..e9f5b25 100644 --- a/docs/interfaces/_runtime_data_compress.GunzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.GunzipOptions.html @@ -1,6 +1,6 @@ -GunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface GunzipOptions

      Options for decompressing GZIP data

      -
      interface GunzipOptions {
          dictionary?: Uint8Array;
          out?: Uint8Array;
      }
      +GunzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface GunzipOptions

      Options for decompressing GZIP data

      +
      interface GunzipOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
          out?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,12 +8,12 @@
      Hierarchy
      -
      +

      Properties

      dictionary? out? -

      Properties

      Optionaldictionary

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

      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.

      -

      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.

      +

      Optionalout

      out?: Uint8Array<ArrayBufferLike>

      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

      On This Page

      Properties
      \ 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 5abea2f..a6c106c 100644 --- a/docs/interfaces/_runtime_data_compress.GunzipStreamOptions.html +++ b/docs/interfaces/_runtime_data_compress.GunzipStreamOptions.html @@ -1,6 +1,6 @@ -GunzipStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface GunzipStreamOptions

      Options for decompressing a GZIP stream

      -
      interface GunzipStreamOptions {
          dictionary?: Uint8Array;
      }
      +GunzipStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface GunzipStreamOptions

      Options for decompressing a GZIP stream

      +
      interface GunzipStreamOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,9 +8,9 @@
      Hierarchy
      -
      +

      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.

      +

      Properties

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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

      On This Page

      Properties
      \ 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 28424ee..79b1631 100644 --- a/docs/interfaces/_runtime_data_compress.GzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.GzipOptions.html @@ -1,6 +1,6 @@ -GzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +GzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface GzipOptions

      Options for compressing data into a GZIP format

      +
      interface GzipOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
          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;
      }
      @@ -8,21 +8,21 @@
      Hierarchy
      -
      +

      Properties

      dictionary? filename? level? mem? mtime? -

      Properties

      Optionaldictionary

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

      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.

      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.

      -

      Optionallevel

      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.

      @@ -34,11 +34,11 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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.

      -

      Optionalmtime

      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

      On This Page

      Properties
      \ 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 59cec1d..5340131 100644 --- a/docs/interfaces/_runtime_data_compress.InflateOptions.html +++ b/docs/interfaces/_runtime_data_compress.InflateOptions.html @@ -1,6 +1,6 @@ -InflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface InflateOptions

      Options for decompressing DEFLATE data

      -
      interface InflateOptions {
          dictionary?: Uint8Array;
          out?: Uint8Array;
      }
      +InflateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface InflateOptions

      Options for decompressing DEFLATE data

      +
      interface InflateOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
          out?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,12 +8,12 @@
      Hierarchy
      -
      +

      Properties

      dictionary? out? -

      Properties

      Optionaldictionary

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

      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.

      -

      Optionalout

      out?: Uint8Array

      The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

      +

      Optionalout

      out?: Uint8Array<ArrayBufferLike>

      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

      On This Page

      Properties
      \ 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 b766ca3..0aedcbe 100644 --- a/docs/interfaces/_runtime_data_compress.InflateStreamOptions.html +++ b/docs/interfaces/_runtime_data_compress.InflateStreamOptions.html @@ -1,6 +1,6 @@ -InflateStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface InflateStreamOptions

      Options for decompressing a DEFLATE stream

      -
      interface InflateStreamOptions {
          dictionary?: Uint8Array;
      }
      +InflateStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface InflateStreamOptions

      Options for decompressing a DEFLATE stream

      +
      interface InflateStreamOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,9 +8,9 @@
      Hierarchy
      -
      +

      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.

      +

      Properties

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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

      On This Page

      Properties
      \ 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 41f6121..ab63e76 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipDecoder.html +++ b/docs/interfaces/_runtime_data_compress.UnzipDecoder.html @@ -1,6 +1,6 @@ -UnzipDecoder | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface UnzipDecoder

      A decoder for files in ZIP streams

      -
      interface UnzipDecoder {
          ondata: AsyncFlateStreamHandler;
          terminate?: AsyncTerminable;
          push(data: Uint8Array, final: boolean): void;
      }
      +UnzipDecoder | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface UnzipDecoder

      A decoder for files in ZIP streams

      +
      interface UnzipDecoder {
          ondata: AsyncFlateStreamHandler;
          terminate?: AsyncTerminable;
          push(data: Uint8Array<ArrayBufferLike>, final: boolean): void;
      }
      @@ -13,10 +13,10 @@

      Methods

      push

      Properties

      ondata terminate? -

      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.

          +

      Methods

      push

      • push(data: Uint8Array<ArrayBufferLike>, final: boolean): void

      • Pushes a chunk to be decompressed

        +

        Parameters

        • data: Uint8Array<ArrayBufferLike>

          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

      Optionalterminate

      terminate?: AsyncTerminable

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

      -

      Settings

      Member Visibility

      On This Page

      Methods
      Properties
      \ 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 6e0bc28..b619dd6 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipDecoderConstructor.html +++ b/docs/interfaces/_runtime_data_compress.UnzipDecoderConstructor.html @@ -1,12 +1,12 @@ -UnzipDecoderConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +UnzipDecoderConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface UnzipDecoderConstructor

      A constructor for a decoder for unzip streams

      +
      interface UnzipDecoderConstructor {
          new UnzipDecoderConstructor(
              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: string,
            size?: number,
            originalSize?: number,
        ): UnzipDecoder

      • Creates an instance of the decoder

        Parameters

        • filename: string

          The name of the file

        • 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

      On This Page

      Constructors
      Properties
      \ 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 68bc3a0..45aa67b 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipFile.html +++ b/docs/interfaces/_runtime_data_compress.UnzipFile.html @@ -1,13 +1,13 @@ -UnzipFile | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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? +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 @@ -16,10 +16,10 @@ 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

      -

      OptionaloriginalSize

      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.

      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

      On This Page

      Methods
      Properties
      \ 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 bd0ee97..bf389d4 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipFileInfo.html +++ b/docs/interfaces/_runtime_data_compress.UnzipFileInfo.html @@ -1,14 +1,14 @@ -UnzipFileInfo | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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 +originalSize size

      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

      +

      originalSize

      originalSize: number

      The original size of the file

      size

      size: number

      The compressed size of the file

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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 c165d52..4635526 100644 --- a/docs/interfaces/_runtime_data_compress.UnzipOptions.html +++ b/docs/interfaces/_runtime_data_compress.UnzipOptions.html @@ -1,6 +1,6 @@ -UnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface UnzipOptions

      Options for expanding a ZIP archive

      -
      interface UnzipOptions {
          filter?: UnzipFileFilter;
      }
      +UnzipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface UnzipOptions

      Options for expanding a ZIP archive

      +
      interface UnzipOptions {
          filter?: UnzipFileFilter;
      }
      @@ -8,8 +8,8 @@
      Hierarchy
      -
      +

      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 +

      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 f2979f8..ca11374 100644 --- a/docs/interfaces/_runtime_data_compress.Unzipped.html +++ b/docs/interfaces/_runtime_data_compress.Unzipped.html @@ -1,4 +1,4 @@ -Unzipped | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Unzipped

      An unzipped archive. The full path of each file is used as the key, +Unzipped | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Interface Unzipped

      An unzipped archive. The full path of each file is used as the key, and the file is the value

      -

      Indexable

      Settings

      Member Visibility
      \ 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 fe76865..1a9b39a 100644 --- a/docs/interfaces/_runtime_data_compress.UnzlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.UnzlibOptions.html @@ -1,6 +1,6 @@ -UnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface UnzlibOptions

      Options for decompressing Zlib data

      -
      interface UnzlibOptions {
          dictionary?: Uint8Array;
          out?: Uint8Array;
      }
      +UnzlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface UnzlibOptions

      Options for decompressing Zlib data

      +
      interface UnzlibOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
          out?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,12 +8,12 @@
      Hierarchy
      -
      +

      Properties

      dictionary? out? -

      Properties

      Optionaldictionary

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

      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.

      -

      Optionalout

      out?: Uint8Array

      The buffer into which to write the decompressed data. Saves memory if you know the decompressed size in advance.

      +

      Optionalout

      out?: Uint8Array<ArrayBufferLike>

      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

      On This Page

      Properties
      \ 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 311d714..a1512f6 100644 --- a/docs/interfaces/_runtime_data_compress.UnzlibStreamOptions.html +++ b/docs/interfaces/_runtime_data_compress.UnzlibStreamOptions.html @@ -1,6 +1,6 @@ -UnzlibStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface UnzlibStreamOptions

      Options for decompressing a Zlib stream

      -
      interface UnzlibStreamOptions {
          dictionary?: Uint8Array;
      }
      +UnzlibStreamOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface UnzlibStreamOptions

      Options for decompressing a Zlib stream

      +
      interface UnzlibStreamOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
      }
      @@ -8,9 +8,9 @@
      Hierarchy
      -
      +

      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.

      +

      Properties

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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

      On This Page

      Properties
      \ 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 9a81174..0656ca9 100644 --- a/docs/interfaces/_runtime_data_compress.ZipAttributes.html +++ b/docs/interfaces/_runtime_data_compress.ZipAttributes.html @@ -1,6 +1,6 @@ -ZipAttributes | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +ZipAttributes | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ZipAttributes

      Attributes for files added to a ZIP archive object

      +
      interface ZipAttributes {
          attrs?: number;
          comment?: string;
          extra?: Record<number, Uint8Array<ArrayBufferLike>>;
          mtime?: string | number | Date;
          os?: number;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      attrs? comment? @@ -30,13 +30,13 @@

      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.

      -

      Optionalextra

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

      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.

      -

      Optionalmtime

      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.

      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

      On This Page

      Properties
      \ 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 821732b..a79b3b9 100644 --- a/docs/interfaces/_runtime_data_compress.ZipInputFile.html +++ b/docs/interfaces/_runtime_data_compress.ZipInputFile.html @@ -1,6 +1,6 @@ -ZipInputFile | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +ZipInputFile | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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<ArrayBufferLike>>;
          filename: string;
          flag?: number;
          mtime?: string | number | Date;
          ondata?: AsyncFlateStreamHandler;
          os?: number;
          size: number;
          terminate?: AsyncTerminable;
      }
      @@ -18,7 +18,7 @@
      Hierarchy
      -
      +

      Properties

      attrs? comment? @@ -56,7 +56,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.

      -

      Optionalextra

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

      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 @@ -67,7 +67,7 @@

      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.

      -

      Optionalmtime

      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.

      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)

      @@ -88,4 +88,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

      On This Page

      Properties
      \ 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 5534ee3..f0ad5b8 100644 --- a/docs/interfaces/_runtime_data_compress.ZipOptions.html +++ b/docs/interfaces/_runtime_data_compress.ZipOptions.html @@ -1,6 +1,6 @@ -ZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +ZipOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ZipOptions

      Options for creating a ZIP archive

      +
      interface ZipOptions {
          attrs?: number;
          comment?: string;
          dictionary?: Uint8Array<ArrayBufferLike>;
          extra?: Record<number, Uint8Array<ArrayBufferLike>>;
          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;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Properties

      attrs? comment? @@ -33,17 +33,17 @@

      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.

      -

      Optionaldictionary

      dictionary?: Uint8Array

      A buffer containing common byte sequences in the input data that can be used to significantly improve compression ratios.

      +

      Optionaldictionary

      dictionary?: Uint8Array<ArrayBufferLike>

      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.

      -

      Optionalextra

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

      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.

      -

      Optionallevel

      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.

      @@ -55,13 +55,13 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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.

      -

      Optionalmtime

      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.

      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

      On This Page

      Properties
      \ 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 2f3afe1..dd272e9 100644 --- a/docs/interfaces/_runtime_data_compress.Zippable.html +++ b/docs/interfaces/_runtime_data_compress.Zippable.html @@ -1,3 +1,3 @@ -Zippable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Zippable

      The complete directory structure of a ZIPpable archive

      -

      Indexable

      Settings

      Member Visibility
      \ No newline at end of file +Zippable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 fa2bda4..20f8fd3 100644 --- a/docs/interfaces/_runtime_data_compress.ZlibOptions.html +++ b/docs/interfaces/_runtime_data_compress.ZlibOptions.html @@ -1,6 +1,6 @@ -ZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +ZlibOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ZlibOptions

      Options for compressing data into a Zlib format

      +
      interface ZlibOptions {
          dictionary?: Uint8Array<ArrayBufferLike>;
          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;
      }
      @@ -8,17 +8,17 @@
      Hierarchy
      -
      +

      Properties

      dictionary? level? mem? -

      Properties

      Optionaldictionary

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

      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.

      -

      Optionallevel

      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.

      @@ -30,9 +30,9 @@
    • become 400 kB with level 1 in 10ms
    • become 320 kB with level 9 in 100ms
      • -

      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.

      +

      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

      On This Page

      Properties
      \ 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 51c6330..1e3c0b6 100644 --- a/docs/interfaces/_runtime_data_format_json5.JSON5.html +++ b/docs/interfaces/_runtime_data_format_json5.JSON5.html @@ -1,37 +1,37 @@ -JSON5 | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +JSON5 | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface JSON5

      interface JSON5 {
          parse<T = any>(
              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.

        -

        Type Parameters

        • T = any

          The type of the return value.

          +

      Methods

      parse

      • parse<T = any>(
            text: string,
            reviver?: (this: any, key: string, value: any) => any,
        ): 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.

          -
        • Optionalreviver: ((this: any, key: string, value: any) => 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.

        +

      Returns T

      The JavaScript value converted from the JSON5 string.

      +

      stringify

      • stringify(
            value: any,
            replacer?: (this: any, key: string, value: any) => any,
            space?: string | number,
        ): string

      • Converts a JavaScript value to a JSON5 string.

        Parameters

        • value: any

          The value to convert to a JSON5 string.

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

        • 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

        • Optionalspace: 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 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.

        Returns string

        The JSON5 string converted from the JavaScript value.

        -
      • stringify(value, replacer, space?): string

      • Converts a JavaScript value to a JSON5 string.

        +
      • stringify(
            value: any,
            replacer: (string | number)[],
            space?: string | number,
        ): string

      • Converts a JavaScript value to a JSON5 string.

        Parameters

        • value: any

          The value to convert to a JSON5 string.

          -
        • replacer: (string | number)[]

          An array of String and Number objects that serve as an allowlist for selecting/filtering the +

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

          -
        • Optionalspace: 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 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.

        Returns string

        The JSON5 string converted from the JavaScript value.

        -
      • stringify(value, options): string

      • Converts a JavaScript value to a JSON5 string.

        +
      • stringify(value: any, options: StringifyOptions): string

      • Converts a JavaScript value to a JSON5 string.

        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

      On This Page

      Methods
      \ 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_jsonc.Edit.html b/docs/interfaces/_runtime_data_format_jsonc.Edit.html index 4a609b5..3c1ad6c 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.Edit.html +++ b/docs/interfaces/_runtime_data_format_jsonc.Edit.html @@ -1,9 +1,9 @@ -Edit | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Edit

      Represents a text modification

      -
      interface Edit {
          content: string;
          length: number;
          offset: number;
      }

      Properties

      content +Edit | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Edit

      Represents a text modification

      +
      interface Edit {
          content: string;
          length: number;
          offset: number;
      }

      Properties

      content length offset

      Properties

      content

      content: string

      The new content. Empty content represents a remove.

      length

      length: number

      The length of the modification. Must not be negative. Empty length represents an insert.

      offset

      offset: number

      The start offset of the modification.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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_jsonc.FormattingOptions.html b/docs/interfaces/_runtime_data_format_jsonc.FormattingOptions.html index 5b39f0c..533b7bf 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.FormattingOptions.html +++ b/docs/interfaces/_runtime_data_format_jsonc.FormattingOptions.html @@ -1,13 +1,13 @@ -FormattingOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface FormattingOptions

      Options used by format when computing the formatting edit operations

      -
      interface FormattingOptions {
          eol?: string;
          insertFinalNewline?: boolean;
          insertSpaces?: boolean;
          keepLines?: boolean;
          tabSize?: number;
      }

      Properties

      eol? -insertFinalNewline? -insertSpaces? -keepLines? -tabSize? +FormattingOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface FormattingOptions

      Options used by format when computing the formatting edit operations

      +
      interface FormattingOptions {
          eol?: string;
          insertFinalNewline?: boolean;
          insertSpaces?: boolean;
          keepLines?: boolean;
          tabSize?: number;
      }

      Properties

      eol? +insertFinalNewline? +insertSpaces? +keepLines? +tabSize?

      Properties

      Optionaleol

      eol?: string

      The default 'end of line' character. If not set, '\n' is used as default.

      -

      OptionalinsertFinalNewline

      insertFinalNewline?: boolean

      If set, will add a new line at the end of the document.

      -

      OptionalinsertSpaces

      insertSpaces?: boolean

      Is indentation based on spaces?

      -

      OptionalkeepLines

      keepLines?: boolean

      If true, will keep line positions as is in the formatting

      -

      OptionaltabSize

      tabSize?: number

      If indentation is based on spaces (insertSpaces = true), the number of spaces that make an indent.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +

      OptionalinsertFinalNewline

      insertFinalNewline?: boolean

      If set, will add a new line at the end of the document.

      +

      OptionalinsertSpaces

      insertSpaces?: boolean

      Is indentation based on spaces?

      +

      OptionalkeepLines

      keepLines?: boolean

      If true, will keep line positions as is in the formatting

      +

      OptionaltabSize

      tabSize?: number

      If indentation is based on spaces (insertSpaces = true), the number of spaces that make an indent.

      +

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.JSONScanner.html b/docs/interfaces/_runtime_data_format_jsonc.JSONScanner.html index 7cc10fa..eaa0d55 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.JSONScanner.html +++ b/docs/interfaces/_runtime_data_format_jsonc.JSONScanner.html @@ -1,23 +1,23 @@ -JSONScanner | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface JSONScanner

      The scanner object, representing a JSON scanner at a position in the input string.

      -
      interface JSONScanner {
          getPosition(): number;
          getToken(): SyntaxKind;
          getTokenError(): ScanError;
          getTokenLength(): number;
          getTokenOffset(): number;
          getTokenStartCharacter(): number;
          getTokenStartLine(): number;
          getTokenValue(): string;
          scan(): SyntaxKind;
          setPosition(pos: number): void;
      }

      Methods

      getPosition -getToken -getTokenError -getTokenLength -getTokenOffset -getTokenStartCharacter -getTokenStartLine -getTokenValue +JSONScanner | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface JSONScanner

      The scanner object, representing a JSON scanner at a position in the input string.

      +
      interface JSONScanner {
          getPosition(): number;
          getToken(): SyntaxKind;
          getTokenError(): ScanError;
          getTokenLength(): number;
          getTokenOffset(): number;
          getTokenStartCharacter(): number;
          getTokenStartLine(): number;
          getTokenValue(): string;
          scan(): SyntaxKind;
          setPosition(pos: number): void;
      }

      Methods

      getPosition +getToken +getTokenError +getTokenLength +getTokenOffset +getTokenStartCharacter +getTokenStartLine +getTokenValue scan -setPosition -

      Methods

      getPosition

      • getPosition(): number

      • Returns the zero-based current scan position, which is after the last read token.

        -

        Returns number

      getToken

      getTokenError

      getTokenLength

      • getTokenLength(): number

      • The length of the last read token.

        -

        Returns number

      getTokenOffset

      • getTokenOffset(): number

      • The zero-based start offset of the last read token.

        -

        Returns number

      getTokenStartCharacter

      • getTokenStartCharacter(): number

      • The zero-based start character (column) of the last read token.

        -

        Returns number

      getTokenStartLine

      • getTokenStartLine(): number

      • The zero-based start line number of the last read token.

        -

        Returns number

      getTokenValue

      • getTokenValue(): string

      • Returns the last read token value. The value for strings is the decoded string content. For numbers it's of type number, for boolean it's true or false.

        -

        Returns string

      scan

      setPosition

      • setPosition(pos): void

      • Sets the scan position to a new offset. A call to 'scan' is needed to get the first token.

        -

        Parameters

        • pos: number

        Returns void

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file +setPosition +

      Methods

      getPosition

      • getPosition(): number

      • Returns the zero-based current scan position, which is after the last read token.

        +

        Returns number

      getToken

      getTokenError

      getTokenLength

      • getTokenLength(): number

      • The length of the last read token.

        +

        Returns number

      getTokenOffset

      • getTokenOffset(): number

      • The zero-based start offset of the last read token.

        +

        Returns number

      getTokenStartCharacter

      • getTokenStartCharacter(): number

      • The zero-based start character (column) of the last read token.

        +

        Returns number

      getTokenStartLine

      • getTokenStartLine(): number

      • The zero-based start line number of the last read token.

        +

        Returns number

      getTokenValue

      • getTokenValue(): string

      • Returns the last read token value. The value for strings is the decoded string content. For numbers it's of type number, for boolean it's true or false.

        +

        Returns string

      scan

      setPosition

      • setPosition(pos: number): void

      • Sets the scan position to a new offset. A call to 'scan' is needed to get the first token.

        +

        Parameters

        • pos: number

        Returns void

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.JSONVisitor.html b/docs/interfaces/_runtime_data_format_jsonc.JSONVisitor.html index 7d4f82a..4d89b2d 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.JSONVisitor.html +++ b/docs/interfaces/_runtime_data_format_jsonc.JSONVisitor.html @@ -1,5 +1,5 @@ -JSONVisitor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface JSONVisitor

      Visitor called by visit when parsing JSON.

      +JSONVisitor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface JSONVisitor

      Visitor called by visit when parsing JSON.

      The visitor functions have the following common parameters:

      • offset: Global offset within the JSON document, starting at 0
        • @@ -8,26 +8,26 @@

      Additionally some functions have a pathSupplier parameter which can be used to obtain the current JSONPath within the document.

      -
      interface JSONVisitor {
          onArrayBegin?: ((offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => boolean | void);
          onArrayEnd?: ((offset: number, length: number, startLine: number, startCharacter: number) => void);
          onComment?: ((offset: number, length: number, startLine: number, startCharacter: number) => void);
          onError?: ((error: ParseErrorCode, offset: number, length: number, startLine: number, startCharacter: number) => void);
          onLiteralValue?: ((value: any, offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => void);
          onObjectBegin?: ((offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => boolean | void);
          onObjectEnd?: ((offset: number, length: number, startLine: number, startCharacter: number) => void);
          onObjectProperty?: ((property: string, offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => void);
          onSeparator?: ((character: string, offset: number, length: number, startLine: number, startCharacter: number) => void);
      }

      Properties

      onArrayBegin? -onArrayEnd? -onComment? -onError? -onLiteralValue? -onObjectBegin? -onObjectEnd? -onObjectProperty? -onSeparator? -

      Properties

      OptionalonArrayBegin

      onArrayBegin?: ((offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => boolean | void)

      Invoked when an open bracket is encountered. The offset and length represent the location of the open bracket. +

      interface JSONVisitor {
          onArrayBegin?: (
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
              pathSupplier: () => JSONPath,
          ) => boolean | void;
          onArrayEnd?: (
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
          ) => void;
          onComment?: (
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
          ) => void;
          onError?: (
              error: ParseErrorCode,
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
          ) => void;
          onLiteralValue?: (
              value: any,
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
              pathSupplier: () => JSONPath,
          ) => void;
          onObjectBegin?: (
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
              pathSupplier: () => JSONPath,
          ) => boolean | void;
          onObjectEnd?: (
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
          ) => void;
          onObjectProperty?: (
              property: string,
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
              pathSupplier: () => JSONPath,
          ) => void;
          onSeparator?: (
              character: string,
              offset: number,
              length: number,
              startLine: number,
              startCharacter: number,
          ) => void;
      }

      Properties

      onArrayBegin? +onArrayEnd? +onComment? +onError? +onLiteralValue? +onObjectBegin? +onObjectEnd? +onObjectProperty? +onSeparator? +

      Properties

      OptionalonArrayBegin

      onArrayBegin?: (
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
          pathSupplier: () => JSONPath,
      ) => boolean | void

      Invoked when an open bracket is encountered. The offset and length represent the location of the open bracket. When false is returned, the array items will not be visited.

      -

      OptionalonArrayEnd

      onArrayEnd?: ((offset: number, length: number, startLine: number, startCharacter: number) => void)

      Invoked when a closing bracket is encountered. The offset and length represent the location of the closing bracket.

      -

      OptionalonComment

      onComment?: ((offset: number, length: number, startLine: number, startCharacter: number) => void)

      When comments are allowed, invoked when a line or block comment is encountered. The offset and length represent the location of the comment.

      -

      OptionalonError

      onError?: ((error: ParseErrorCode, offset: number, length: number, startLine: number, startCharacter: number) => void)

      Invoked on an error.

      -

      OptionalonLiteralValue

      onLiteralValue?: ((value: any, offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => void)

      Invoked when a literal value is encountered. The offset and length represent the location of the literal value.

      -

      OptionalonObjectBegin

      onObjectBegin?: ((offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => boolean | void)

      Invoked when an open brace is encountered and an object is started. The offset and length represent the location of the open brace. +

      OptionalonArrayEnd

      onArrayEnd?: (
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
      ) => void

      Invoked when a closing bracket is encountered. The offset and length represent the location of the closing bracket.

      +

      OptionalonComment

      onComment?: (
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
      ) => void

      When comments are allowed, invoked when a line or block comment is encountered. The offset and length represent the location of the comment.

      +

      OptionalonError

      onError?: (
          error: ParseErrorCode,
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
      ) => void

      Invoked on an error.

      +

      OptionalonLiteralValue

      onLiteralValue?: (
          value: any,
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
          pathSupplier: () => JSONPath,
      ) => void

      Invoked when a literal value is encountered. The offset and length represent the location of the literal value.

      +

      OptionalonObjectBegin

      onObjectBegin?: (
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
          pathSupplier: () => JSONPath,
      ) => boolean | void

      Invoked when an open brace is encountered and an object is started. The offset and length represent the location of the open brace. When false is returned, the object properties will not be visited.

      -

      OptionalonObjectEnd

      onObjectEnd?: ((offset: number, length: number, startLine: number, startCharacter: number) => void)

      Invoked when a closing brace is encountered and an object is completed. The offset and length represent the location of the closing brace.

      -

      OptionalonObjectProperty

      onObjectProperty?: ((property: string, offset: number, length: number, startLine: number, startCharacter: number, pathSupplier: (() => JSONPath)) => void)

      Invoked when a property is encountered. The offset and length represent the location of the property name. +

      OptionalonObjectEnd

      onObjectEnd?: (
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
      ) => void

      Invoked when a closing brace is encountered and an object is completed. The offset and length represent the location of the closing brace.

      +

      OptionalonObjectProperty

      onObjectProperty?: (
          property: string,
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
          pathSupplier: () => JSONPath,
      ) => void

      Invoked when a property is encountered. The offset and length represent the location of the property name. The JSONPath created by the pathSupplier refers to the enclosing JSON object, it does not include the property name yet.

      -

      OptionalonSeparator

      onSeparator?: ((character: string, offset: number, length: number, startLine: number, startCharacter: number) => void)

      Invoked when a comma or colon separator is encountered. The offset and length represent the location of the separator.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +

      OptionalonSeparator

      onSeparator?: (
          character: string,
          offset: number,
          length: number,
          startLine: number,
          startCharacter: number,
      ) => void

      Invoked when a comma or colon separator is encountered. The offset and length represent the location of the separator.

      +

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.Location.html b/docs/interfaces/_runtime_data_format_jsonc.Location.html index 5079f19..706f9ed 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.Location.html +++ b/docs/interfaces/_runtime_data_format_jsonc.Location.html @@ -1,13 +1,13 @@ -Location | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Location

      interface Location {
          isAtPropertyKey: boolean;
          matches: ((patterns: JSONPath) => boolean);
          path: JSONPath;
          previousNode?: Node;
      }

      Properties

      isAtPropertyKey +Location | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Location

      interface Location {
          isAtPropertyKey: boolean;
          matches: (patterns: JSONPath) => boolean;
          path: JSONPath;
          previousNode?: Node;
      }

      Properties

      isAtPropertyKey matches path -previousNode? -

      Properties

      isAtPropertyKey

      isAtPropertyKey: boolean

      If set, the location's offset is at a property key.

      -

      matches

      matches: ((patterns: JSONPath) => boolean)

      Matches the locations path against a pattern consisting of strings (for properties) and numbers (for array indices). +previousNode? +

      Properties

      isAtPropertyKey

      isAtPropertyKey: boolean

      If set, the location's offset is at a property key.

      +

      matches

      matches: (patterns: JSONPath) => boolean

      Matches the locations path against a pattern consisting of strings (for properties) and numbers (for array indices). '*' will match a single segment of any property name or index. '**' will match a sequence of segments of any property name or index, or no segment.

      path

      path: JSONPath

      The path describing the location in the JSON document. The path consists of a sequence of strings representing an object property or numbers for array indices.

      -

      OptionalpreviousNode

      previousNode?: Node

      The previous property key or literal value (string, number, boolean or null) or undefined.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +

      OptionalpreviousNode

      previousNode?: Node

      The previous property key or literal value (string, number, boolean or null) or undefined.

      +

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.ModificationOptions.html b/docs/interfaces/_runtime_data_format_jsonc.ModificationOptions.html index 3b0dd9a..fd09baa 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.ModificationOptions.html +++ b/docs/interfaces/_runtime_data_format_jsonc.ModificationOptions.html @@ -1,10 +1,10 @@ -ModificationOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface ModificationOptions

      Options used by modify when computing the modification edit operations

      -
      interface ModificationOptions {
          formattingOptions?: FormattingOptions;
          getInsertionIndex?: ((properties: string[]) => number);
          isArrayInsertion?: boolean;
      }

      Properties

      formattingOptions? -getInsertionIndex? -isArrayInsertion? -

      Properties

      OptionalformattingOptions

      formattingOptions?: FormattingOptions

      Formatting options. If undefined, the newly inserted code will be inserted unformatted.

      -

      OptionalgetInsertionIndex

      getInsertionIndex?: ((properties: string[]) => number)

      Optional function to define the insertion index given an existing list of properties.

      -

      OptionalisArrayInsertion

      isArrayInsertion?: boolean

      Default false. If JSONPath refers to an index of an array and isArrayInsertion is true, then +ModificationOptions | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Interface ModificationOptions

      Options used by modify when computing the modification edit operations

      +
      interface ModificationOptions {
          formattingOptions?: FormattingOptions;
          getInsertionIndex?: (properties: string[]) => number;
          isArrayInsertion?: boolean;
      }

      Properties

      formattingOptions? +getInsertionIndex? +isArrayInsertion? +

      Properties

      OptionalformattingOptions

      formattingOptions?: FormattingOptions

      Formatting options. If undefined, the newly inserted code will be inserted unformatted.

      +

      OptionalgetInsertionIndex

      getInsertionIndex?: (properties: string[]) => number

      Optional function to define the insertion index given an existing list of properties.

      +

      OptionalisArrayInsertion

      isArrayInsertion?: boolean

      Default false. If JSONPath refers to an index of an array and isArrayInsertion is true, then modify will insert a new item at that location instead of overwriting its contents.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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_jsonc.Node.html b/docs/interfaces/_runtime_data_format_jsonc.Node.html index fdd9a80..874980f 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.Node.html +++ b/docs/interfaces/_runtime_data_format_jsonc.Node.html @@ -1,9 +1,9 @@ -Node | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Node

      interface Node {
          children?: Node[];
          colonOffset?: number;
          length: number;
          offset: number;
          parent?: Node;
          type: NodeType;
          value?: any;
      }

      Properties

      children? -colonOffset? +Node | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Node

      interface Node {
          children?: Node[];
          colonOffset?: number;
          length: number;
          offset: number;
          parent?: Node;
          type: NodeType;
          value?: any;
      }

      Properties

      children? +colonOffset? length offset parent? type value? -

      Properties

      Optional Readonlychildren

      children?: Node[]

      Optional ReadonlycolonOffset

      colonOffset?: number

      Readonlylength

      length: number

      Readonlyoffset

      offset: number

      Optional Readonlyparent

      parent?: Node

      Readonlytype

      type: NodeType

      Optional Readonlyvalue

      value?: any

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +

      Properties

      Optional Readonlychildren

      children?: Node[]

      Optional ReadonlycolonOffset

      colonOffset?: number

      Readonlylength

      length: number

      Readonlyoffset

      offset: number

      Optional Readonlyparent

      parent?: Node

      Readonlytype

      type: NodeType

      Optional Readonlyvalue

      value?: any

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.ParseError.html b/docs/interfaces/_runtime_data_format_jsonc.ParseError.html index e83cd81..789bddc 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.ParseError.html +++ b/docs/interfaces/_runtime_data_format_jsonc.ParseError.html @@ -1,5 +1,5 @@ -ParseError | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface ParseError

      interface ParseError {
          error: ParseErrorCode;
          length: number;
          offset: number;
      }

      Properties

      error +ParseError | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ParseError

      interface ParseError {
          error: ParseErrorCode;
          length: number;
          offset: number;
      }

      Properties

      error length offset -

      Properties

      error

      error: ParseErrorCode

      length

      length: number

      offset

      offset: number

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +

      Properties

      error

      error: ParseErrorCode

      length

      length: number

      offset

      offset: number

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.ParseOptions.html b/docs/interfaces/_runtime_data_format_jsonc.ParseOptions.html index 41e165e..c17f908 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.ParseOptions.html +++ b/docs/interfaces/_runtime_data_format_jsonc.ParseOptions.html @@ -1,5 +1,5 @@ -ParseOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface ParseOptions

      interface ParseOptions {
          allowEmptyContent?: boolean;
          allowTrailingComma?: boolean;
          disallowComments?: boolean;
      }

      Properties

      allowEmptyContent? -allowTrailingComma? -disallowComments? -

      Properties

      OptionalallowEmptyContent

      allowEmptyContent?: boolean

      OptionalallowTrailingComma

      allowTrailingComma?: boolean

      OptionaldisallowComments

      disallowComments?: boolean

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +ParseOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ParseOptions

      interface ParseOptions {
          allowEmptyContent?: boolean;
          allowTrailingComma?: boolean;
          disallowComments?: boolean;
      }

      Properties

      allowEmptyContent? +allowTrailingComma? +disallowComments? +

      Properties

      OptionalallowEmptyContent

      allowEmptyContent?: boolean

      OptionalallowTrailingComma

      allowTrailingComma?: boolean

      OptionaldisallowComments

      disallowComments?: boolean

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_format_jsonc.Range.html b/docs/interfaces/_runtime_data_format_jsonc.Range.html index 0cd56a9..2de557e 100644 --- a/docs/interfaces/_runtime_data_format_jsonc.Range.html +++ b/docs/interfaces/_runtime_data_format_jsonc.Range.html @@ -1,7 +1,7 @@ -Range | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Range

      A text range in the document

      -
      interface Range {
          length: number;
          offset: number;
      }

      Properties

      length +Range | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Range

      A text range in the document

      +
      interface Range {
          length: number;
          offset: number;
      }

      Properties

      length offset

      Properties

      length

      length: number

      The length of the range. Must not be negative.

      offset

      offset: number

      The start offset of the range.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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_msgpack.Options.html b/docs/interfaces/_runtime_data_format_msgpack.Options.html index d24ba69..df7ee57 100644 --- a/docs/interfaces/_runtime_data_format_msgpack.Options.html +++ b/docs/interfaces/_runtime_data_format_msgpack.Options.html @@ -1,30 +1,30 @@ -Options | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Options

      interface Options {
          bundleStrings?: boolean;
          coercibleKeyAsNumber?: boolean;
          copyBuffers?: boolean;
          encodeUndefinedAsNil?: boolean;
          int64AsNumber?: boolean;
          int64AsType?: "string" | "number" | "bigint";
          largeBigIntToFloat?: boolean;
          largeBigIntToString?: 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;
          writeFunction?: (() => any);
          getStructures?(): {}[];
          saveStructures?(structures: {}[]): boolean | void;
      }

      Methods

      getStructures? -saveStructures? -

      Properties

      bundleStrings? -coercibleKeyAsNumber? -copyBuffers? -encodeUndefinedAsNil? -int64AsNumber? -int64AsType? -largeBigIntToFloat? -largeBigIntToString? -mapAsEmptyObject? -mapsAsObjects? -maxOwnStructures? -maxSharedStructures? -moreTypes? -onInvalidDate? +Options | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Options

      interface Options {
          bundleStrings?: boolean;
          coercibleKeyAsNumber?: boolean;
          copyBuffers?: boolean;
          encodeUndefinedAsNil?: boolean;
          int64AsNumber?: boolean;
          int64AsType?: "string" | "number" | "bigint";
          largeBigIntToFloat?: boolean;
          largeBigIntToString?: 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;
          writeFunction?: () => any;
          getStructures(): {}[];
          saveStructures(structures: {}[]): boolean | void;
      }

      Methods

      getStructures? +saveStructures? +

      Properties

      bundleStrings? +coercibleKeyAsNumber? +copyBuffers? +encodeUndefinedAsNil? +int64AsNumber? +int64AsType? +largeBigIntToFloat? +largeBigIntToString? +mapAsEmptyObject? +mapsAsObjects? +maxOwnStructures? +maxSharedStructures? +moreTypes? +onInvalidDate? sequential? -setAsEmptyObject? -shouldShareStructure? -structuredClone? +setAsEmptyObject? +shouldShareStructure? +structuredClone? structures? -useBigIntExtension? -useFloat32? -useRecords? -useTimestamp32? -variableMapSize? -writeFunction? -

      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

      OptionallargeBigIntToString

      largeBigIntToString?: 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

      OptionalwriteFunction

      writeFunction?: (() => any)

      Settings

      Member Visibility

      On This Page

      Methods
      Properties
      \ No newline at end of file +useBigIntExtension? +useFloat32? +useRecords? +useTimestamp32? +variableMapSize? +writeFunction? +

      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

      OptionallargeBigIntToString

      largeBigIntToString?: 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

      OptionalwriteFunction

      writeFunction?: () => any

      Settings

      Member Visibility

      On This Page

      Methods
      Properties
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_data_struct_search_trie.TrieSearchReducer.html b/docs/interfaces/_runtime_data_struct_search_trie.TrieSearchReducer.html index 32d2af3..7e6de94 100644 --- a/docs/interfaces/_runtime_data_struct_search_trie.TrieSearchReducer.html +++ b/docs/interfaces/_runtime_data_struct_search_trie.TrieSearchReducer.html @@ -1,6 +1,6 @@ -TrieSearchReducer | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface TrieSearchReducer<T>

      Provides an interface for all reducers.

      -
      interface TrieSearchReducer<T> {
          get keyFields(): Key | KeyFields;
          get matches(): T[];
          reduce(data: TrieSearchReducerData<T>): void;
          reset(data: TrieSearchReducerResetData<T>): void;
      }

      Type Parameters

      • T extends object
      +TrieSearchReducer | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface TrieSearchReducer<T>

      Provides an interface for all reducers.

      +
      interface TrieSearchReducer<T extends object> {
          get keyFields(): Key | KeyFields;
          get matches(): T[];
          reduce(data: TrieSearchReducerData<T>): void;
          reset(data: TrieSearchReducerResetData<T>): void;
      }

      Type Parameters

      • T extends object
      @@ -10,15 +10,15 @@
      -

      Accessors

      keyFields +

      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.

        -

        Parameters

        Returns void

      reset

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ No newline at end of file +

      matches

      • get matches(): T[]

      • Returns T[]

        The matches after reducing.

        +

      Methods

      reduce

      reset

      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 667774d..4cd2310 100644 --- a/docs/interfaces/_runtime_math_interpolate.InterpolateFunction.html +++ b/docs/interfaces/_runtime_math_interpolate.InterpolateFunction.html @@ -1,7 +1,7 @@ -InterpolateFunction | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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.

          +InterpolateFunction | TyphonJS Runtime Library (FVTT) 0.2.0
          +

          Interface InterpolateFunction<T>

          Defines the shape of an interpolation function.

          +

          Type Parameters

          • T
          • InterpolateFunction(start: T, end: T, amount: number): 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
          \ No newline at end of file +

        Returns T

        Interpolated value between start & end.

        +

      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 85b2d4e..f0c1efc 100644 --- a/docs/interfaces/_runtime_plugin_manager.PluginSupportConstructor.html +++ b/docs/interfaces/_runtime_plugin_manager.PluginSupportConstructor.html @@ -1,3 +1,3 @@ -PluginSupportConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +PluginSupportConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface PluginSupportConstructor

      interface PluginSupportConstructor {
          new PluginSupportConstructor(
              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 f82382c..2e03b0d 100644 --- a/docs/interfaces/_runtime_plugin_manager.PluginSupportImpl.html +++ b/docs/interfaces/_runtime_plugin_manager.PluginSupportImpl.html @@ -1,6 +1,6 @@ -PluginSupportImpl | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +PluginSupportImpl | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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;
      }
      @@ -11,20 +11,20 @@

      Methods

      destroy -setEventbus -setOptions -

      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 +setEventbus +setOptions +

      Methods

      destroy

      • destroy(opts: { eventbus: Eventbus; eventPrepend: string }): 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: {
                newEventbus: Eventbus;
                newPrepend: string;
                oldEventbus: Eventbus;
                oldPrepend: string;
            },
        ): 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: {
              newEventbus: Eventbus;
              newPrepend: string;
              oldEventbus: Eventbus;
              oldPrepend: string;
          }

          An options object.

          -
          • newEventbus: Eventbus

            The new eventbus to associate.

            -
          • newPrepend: string

            The new event prepend.

            -
          • oldEventbus: Eventbus

            The old eventbus to disassociate.

            -
          • oldPrepend: string

            The old event prepend.

            -

        Returns void

      setOptions

      • setOptions(options): void

      • Set optional parameters.

        +

        Parameters

        • opts: {
              newEventbus: Eventbus;
              newPrepend: string;
              oldEventbus: Eventbus;
              oldPrepend: string;
          }

          An options object.

          +
          • newEventbus: Eventbus

            The new eventbus to associate.

            +
          • newPrepend: string

            The new event prepend.

            +
          • oldEventbus: Eventbus

            The old eventbus to disassociate.

            +
          • oldPrepend: string

            The old event prepend.

            +

        Returns void

      setOptions

      Settings

      Member Visibility

      On This Page

      Methods
      \ 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_animate_gsap.Action.DraggableGsapOptionsStore.html b/docs/interfaces/_runtime_svelte_animate_gsap.Action.DraggableGsapOptionsStore.html index 87d4ecd..cda5ebc 100644 --- a/docs/interfaces/_runtime_svelte_animate_gsap.Action.DraggableGsapOptionsStore.html +++ b/docs/interfaces/_runtime_svelte_animate_gsap.Action.DraggableGsapOptionsStore.html @@ -1,8 +1,8 @@ -DraggableGsapOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DraggableGsapOptionsStore

      Provides an interface of the draggableGsap action options support / Readable store to make updating / +DraggableGsapOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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: void, run: Subscriber<DraggableGsapOptionsStore>, invalidate?: Invalidator<DraggableGsapOptionsStore>): Unsubscriber;
      }
      +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 }): void;
          get inertiaDurationMax(): number;
          set inertiaDurationMax(max: number): void;
          get inertiaDurationMin(): number;
          set inertiaDurationMin(min: number): void;
          get inertiaEnd(): number | Function | any[];
          set inertiaEnd(end: number | Function | any[]): void;
          get inertiaResistance(): number;
          set inertiaResistance(resistance: number): void;
          get inertiaVelocityScale(): number;
          set inertiaVelocityScale(velocityScale: number): void;
          get tweenDuration(): number;
          set tweenDuration(duration: number): void;
          get tweenEase(): string | Function;
          set tweenEase(value: string | Function): void;
          reset(): void;
          resetInertia(): void;
          resetInertiaOptions(): void;
          resetTween(): void;
          resetTweenOptions(): void;
          subscribe(
              this: void,
              run: Subscriber<DraggableGsapOptionsStore>,
              invalidate?: Invalidator<DraggableGsapOptionsStore>,
          ): Unsubscriber;
      }
      @@ -10,53 +10,53 @@
      Hierarchy
      -
      +
      -

      Accessors

      inertiaDuration -inertiaDurationMax -inertiaDurationMin -inertiaEnd -inertiaResistance -inertiaVelocityScale -tweenDuration -tweenEase +

      Accessors

      inertiaDuration +inertiaDurationMax +inertiaDurationMin +inertiaEnd +inertiaResistance +inertiaVelocityScale +tweenDuration +tweenEase

      Methods

      reset -resetInertia -resetInertiaOptions -resetTween -resetTweenOptions +resetInertia +resetInertiaOptions +resetTween +resetTweenOptions subscribe

      Properties

      inertia -inertiaOptions +inertiaOptions tween -tweenOptions -

      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

      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.

        -
      • set inertiaVelocityScale(velocityScale): void

      • Parameters

        • velocityScale: number

          Set inertia velocity scale.

          -

        Returns void

      tweenDuration

      • get tweenDuration(): number

      • Returns number

        Get ease duration

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

      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

      Accessors

      inertiaDuration

      • set inertiaDuration(duration: { max: number; min: number }): void

      • Parameters

        • duration: { max: number; min: number }

          Set inertia duration min & max.

          +

        Returns void

      inertiaDurationMax

      • get inertiaDurationMax(): number

      • Returns number

        Get inertia duration max time (seconds)

        +
      • set inertiaDurationMax(max: number): 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: number): void

      • Parameters

        • min: number

          Set inertia duration min.

          +

        Returns void

      inertiaEnd

      inertiaResistance

      • get inertiaResistance(): number

      • Returns number

        Get inertia resistance (1000 is default).

        +
      • set inertiaResistance(resistance: number): void

      • Parameters

        • resistance: number

          Set inertia resistance. Default: 1000

          +

        Returns void

      inertiaVelocityScale

      • get inertiaVelocityScale(): number

      • Returns number

        Get inertia velocity scale.

        +
      • set inertiaVelocityScale(velocityScale: number): void

      • Parameters

        • velocityScale: number

          Set inertia velocity scale.

          +

        Returns void

      tweenDuration

      • get tweenDuration(): number

      • Returns number

        Get ease duration

        +
      • set tweenDuration(duration: number): void

      • Parameters

        • duration: number

          Set ease duration.

          +

        Returns void

      tweenEase

      • get tweenEase(): string | Function

      • Returns string | Function

        Get easing function value.

        +
      • set tweenEase(value: string | Function): void

      • Parameters

        • value: string | Function

          Get easing function value.

          +

        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.

      -

      inertiaOptions

      inertiaOptions: GsapInertiaOptions

      Inertia options.

      +

      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

      On This Page

      Accessors
      Methods
      Properties
      \ No newline at end of file +

      tweenOptions

      tweenOptions: GsapTweenOptions

      GSAP tween options for easing function and duration.

      +

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      Properties
      \ 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 fcf4857..fbffe84 100644 --- a/docs/interfaces/_runtime_svelte_application.ApplicationState.html +++ b/docs/interfaces/_runtime_svelte_application.ApplicationState.html @@ -1,8 +1,8 @@ -ApplicationState | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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?: object): ApplicationStateData;
          get(options: {
              name: string;
          }): ApplicationStateData;
          keys(): IterableIterator<string, any, any>;
          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 +
      interface ApplicationState {
          clear(): void;
          current(extra?: object): ApplicationStateData;
          get(options: { name: string }): ApplicationStateData;
          keys(): IterableIterator<string, any, any>;
          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 @@ -10,42 +10,42 @@ restore save set -

      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.

        +

      Methods

      clear

      • clear(): void

      • Clears all saved application state.

        +

        Returns void

      current

      • current(extra?: object): ApplicationStateData

      • Returns current application state along with any extra data passed into method.

        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.

          -
          • name: string

            Saved data set name.

            +

      get

      • get(options: { name: string }): ApplicationStateData

      • Gets any saved application state by name.

        +

        Parameters

        • options: { name: string }

          Options.

          +
          • name: string

            Saved data set name.

        Returns ApplicationStateData

        Any saved application state.

        -

      keys

      remove

      • remove(options): ApplicationStateData

      • Removes and returns any saved application state by name.

        -

        Parameters

        • options: {
              name: string;
          }

          Options.

          -
          • name: string

            Name to remove and retrieve.

            +

      keys

      remove

      • remove(options: { name: string }): ApplicationStateData

      • Removes and returns any saved application state by name.

        +

        Parameters

        • options: { name: string }

          Options.

          +
          • name: string

            Name to remove and retrieve.

        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 +

      restore

      • restore(
            options: {
                animateTo?: boolean;
                duration?: number;
                ease?: EasingReference;
                name: string;
                remove?: boolean;
            },
        ): 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.

        -

        Parameters

        • options: {
              animateTo?: boolean;
              duration?: number;
              ease?: EasingReference;
              name: string;
              remove?: boolean;
          }

          Parameters

          -
          • OptionalanimateTo?: boolean

            Animate to restore data.

            -
          • Optionalduration?: number

            Duration in seconds.

            -
          • Optionalease?: EasingReference

            Easing function name or function.

            -
          • name: string

            Saved data set name.

            -
          • Optionalremove?: boolean

            Remove data set.

            +

            Parameters

            • options: {
                  animateTo?: boolean;
                  duration?: number;
                  ease?: EasingReference;
                  name: string;
                  remove?: boolean;
              }

              Parameters

              +
              • OptionalanimateTo?: boolean

                Animate to restore data.

                +
              • Optionalduration?: number

                Duration in seconds.

                +
              • Optionalease?: EasingReference

                Easing function name or function.

                +
              • name: string

                Saved data set name.

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

          -
          • Optionalextra?: any[]

            Extra data to add to saved state.

            -
          • name: string

            Name to index this saved state.

            +

      save

      • save(options: { extra?: any[]; name: string }): ApplicationStateData

      • Saves current application state with the opportunity to add extra data to the saved state.

        +

        Parameters

        • options: { extra?: any[]; name: string }

          Options.

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

      set

      • set(
            data: ApplicationStateData,
            options?: {
                animateTo?: boolean;
                async?: boolean;
                duration?: number;
                ease?: EasingReference;
            },
        ): 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.

        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.

          -
        • 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 +
    • 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 4a01c1c..5e6f60a 100644 --- a/docs/interfaces/_runtime_svelte_application.GetSvelteData.html +++ b/docs/interfaces/_runtime_svelte_application.GetSvelteData.html @@ -1,35 +1,35 @@ -GetSvelteData | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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>], any, any>;
          componentValues(): IterableIterator<SvelteComponent<any, any, any>, any, any>;
          data(index: number): SvelteData;
          dataByComponent(component: SvelteComponent<any, any, any>): SvelteData;
          dataEntries(): IterableIterator<[number, SvelteData], any, any>;
          dataValues(): IterableIterator<SvelteData, any, any>;
      }

      Accessors

      applicationShell +GetSvelteData | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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>],
              any,
              any,
          >;
          componentValues(): IterableIterator<
              SvelteComponent<any, any, any>,
              any,
              any,
          >;
          data(index: number): SvelteData;
          dataByComponent(component: SvelteComponent<any, any, any>): SvelteData;
          dataEntries(): IterableIterator<[number, SvelteData], any, any>;
          dataValues(): IterableIterator<SvelteData, any, any>;
      }

      Accessors

      applicationShell length

      Methods

      component -componentEntries -componentValues +componentEntries +componentValues data -dataByComponent -dataEntries -dataValues -

      Accessors

      applicationShell

      Accessors

      applicationShell

      length

      • get length(): number

      • Returns the length of the mounted Svelte component list.

        +

      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: number): object

      • Returns the indexed Svelte component.

        Parameters

        • index: number

          The index of Svelte component to retrieve.

        Returns object

        The loaded Svelte component.

        -

      componentEntries

      componentValues

      data

      • data(index): SvelteData

      • Returns the indexed SvelteData entry.

        +

      componentEntries

      componentValues

      data

      • data(index: number): SvelteData

      • Returns the indexed SvelteData entry.

        Parameters

        • index: number

          The index of SvelteData instance to retrieve.

        Returns SvelteData

        The loaded Svelte config + component.

        -

      dataByComponent

      dataByComponent

      dataEntries

      dataValues

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ No newline at end of file +

      dataEntries

      dataValues

      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 aad34c4..bcfd688 100644 --- a/docs/interfaces/_runtime_svelte_application.SvelteReactive.html +++ b/docs/interfaces/_runtime_svelte_application.SvelteReactive.html @@ -1,8 +1,8 @@ -SvelteReactive | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface SvelteReactive

      Contains the reactive functionality / Svelte stores associated with SvelteApplication and retrievable by +SvelteReactive | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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:

      +SvelteReactive.storeUIState:

      There are also reactive getters / setters for SvelteApplicationOptions and Foundry ApplicationOptions. You can use the following as one way bindings and update the associated stores. For -two-way bindings / stores see SvelteReactive.storeAppOptions.

      +two-way bindings / stores see SvelteReactive.storeAppOptions.

      -

      An instance of TJSWebStorage (session) / TJSSessionStorage is accessible via SvelteReactive.sessionStorage. +

      An instance of TJSWebStorage (session) / TJSSessionStorage is accessible via SvelteReactive.sessionStorage. Optionally you can pass in an existing TJSWebStorage instance that can be shared across multiple SvelteApplications -by setting SvelteApplicationOptions.sessionStorage.

      +by setting SvelteApplicationOptions.sessionStorage.

      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; }
         }
      });
+

      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(): WebStorage;
          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 +
      interface SvelteReactive {
          get activeWindow(): Window;
          set activeWindow(activeWindow: Window): void;
          get draggable(): boolean;
          set draggable(draggable: boolean): void;
          get dragging(): boolean;
          get focusAuto(): boolean;
          set focusAuto(focusAuto: boolean): void;
          get focusKeep(): boolean;
          set focusKeep(focusKeep: boolean): void;
          get focusTrap(): boolean;
          set focusTrap(focusTrap: boolean): void;
          get headerButtonNoClose(): boolean;
          set headerButtonNoClose(headerButtonNoClose: boolean): void;
          get headerButtonNoLabel(): boolean;
          set headerButtonNoLabel(headerButtonNoLabel: boolean): void;
          get headerIcon(): string;
          set headerIcon(headerIcon: string): void;
          get headerNoTitleMinimized(): boolean;
          set headerNoTitleMinimized(headerNoTitleMinimized: boolean): void;
          get minimizable(): boolean;
          set minimizable(minimizable: boolean): void;
          get minimized(): boolean;
          get popOut(): boolean;
          set popOut(popOut: boolean): void;
          get positionable(): boolean;
          set positionable(positionable: boolean): void;
          get resizable(): boolean;
          set resizable(resizable: boolean): void;
          get resizing(): boolean;
          get sessionStorage(): WebStorage;
          get storeAppOptions(): StoreAppOptions;
          get storeUIState(): StoreUIOptions;
          get title(): string;
          set title(title: string): void;
          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 -focusKeep -focusTrap -headerButtonNoClose -headerButtonNoLabel -headerIcon -headerNoTitleMinimized +focusAuto +focusKeep +focusTrap +headerButtonNoClose +headerButtonNoLabel +headerIcon +headerNoTitleMinimized minimizable minimized -popOut +popOut positionable resizable resizing -sessionStorage -storeAppOptions -storeUIState +sessionStorage +storeAppOptions +storeUIState title -

      Methods

      getOptions -mergeOptions -setOptions -toJSON -updateHeaderButtons -

      Accessors

      activeWindow

      • get activeWindow(): Window

      • Returns the current active Window / WindowProxy UI state.

        +

      Methods

      getOptions +mergeOptions +setOptions +toJSON +updateHeaderButtons +

      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.

        +
      • set activeWindow(activeWindow: Window): void

      • Sets the current active Window / WindowProxy UI state.

        Note: This is protected usage and used internally.

        Parameters

        • activeWindow: Window

          Active Window / WindowProxy UI state.

          -

        Returns void

      draggable

      • get draggable(): boolean

      • Returns the draggable app option.

        +

      Returns void

      draggable

      • get draggable(): boolean

      • Returns the draggable app option.

        Returns boolean

        Draggable app option.

        -
      • set draggable(draggable): void

      • Sets this.options.draggable which is reactive for application shells.

        +
      • set draggable(draggable: boolean): void

      • Sets this.options.draggable which is reactive for application shells.

        Parameters

        • draggable: boolean

          Sets the draggable option.

          -

        Returns void

      dragging

      • get dragging(): boolean

      • Returns the current dragging UI state.

        +

      Returns void

      dragging

      • get dragging(): boolean

      • Returns the current dragging UI state.

        Returns boolean

        Dragging UI state.

        -

      focusAuto

      • get focusAuto(): boolean

      • Returns the focusAuto app option.

        +

      focusAuto

      • get focusAuto(): boolean

      • Returns the focusAuto app option.

        Returns boolean

        When true auto-management of app focus is enabled.

        -
      • set focusAuto(focusAuto): void

      • Sets this.options.focusAuto which is reactive for application shells.

        +
      • set focusAuto(focusAuto: boolean): void

      • Sets this.options.focusAuto which is reactive for application shells.

        Parameters

        • focusAuto: boolean

          Sets the focusAuto option.

          -

        Returns void

      focusKeep

      • get focusKeep(): boolean

      • Returns the focusKeep app option.

        +

      Returns void

      focusKeep

      • get focusKeep(): boolean

      • Returns the focusKeep app option.

        Returns boolean

        When focusAuto and focusKeep is true; keeps internal focus.

        -
      • set focusKeep(focusKeep): void

      • Sets this.options.focusKeep which is reactive for application shells.

        +
      • set focusKeep(focusKeep: boolean): void

      • Sets this.options.focusKeep which is reactive for application shells.

        Parameters

        • focusKeep: boolean

          Sets the focusKeep option.

          -

        Returns void

      focusTrap

      • get focusTrap(): boolean

      • Returns the focusTrap app option.

        +

      Returns void

      focusTrap

      • get focusTrap(): boolean

      • Returns the focusTrap app option.

        Returns boolean

        When true focus trapping / wrapping is enabled keeping focus inside app.

        -
      • set focusTrap(focusTrap): void

      • Sets this.options.focusTrap which is reactive for application shells.

        +
      • set focusTrap(focusTrap: boolean): void

      • Sets this.options.focusTrap which is reactive for application shells.

        Parameters

        • focusTrap: boolean

          Sets the focusTrap option.

          -

        Returns void

      headerButtonNoClose

      • get headerButtonNoClose(): boolean

      • Returns the headerButtonNoClose app option.

        +

      Returns void

      headerButtonNoClose

      • get headerButtonNoClose(): boolean

      • Returns the headerButtonNoClose app option.

        Returns boolean

        Remove the close the button in header app option.

        -
      • set headerButtonNoClose(headerButtonNoClose): void

      • Sets this.options.headerButtonNoClose which is reactive for application shells.

        +
      • set headerButtonNoClose(headerButtonNoClose: boolean): void

      • Sets this.options.headerButtonNoClose which is reactive for application shells.

        Parameters

        • headerButtonNoClose: boolean

          Sets the headerButtonNoClose option.

          -

        Returns void

      headerButtonNoLabel

      • get headerButtonNoLabel(): boolean

      • Returns the headerButtonNoLabel app option.

        +

      Returns void

      headerButtonNoLabel

      • get headerButtonNoLabel(): boolean

      • Returns the headerButtonNoLabel app option.

        Returns boolean

        Remove the labels from buttons in header app option.

        -
      • set headerButtonNoLabel(headerButtonNoLabel): void

      • Sets this.options.headerButtonNoLabel which is reactive for application shells.

        +
      • set headerButtonNoLabel(headerButtonNoLabel: boolean): void

      • Sets this.options.headerButtonNoLabel which is reactive for application shells.

        Parameters

        • headerButtonNoLabel: boolean

          Sets the headerButtonNoLabel option.

          -

        Returns void

      headerIcon

      • get headerIcon(): string

      • Returns the headerIcon app option.

        +

      Returns void

      headerIcon

      • get headerIcon(): string

      • Returns the headerIcon app option.

        Returns string

        URL for header app icon.

        -
      • set headerIcon(headerIcon): void

      • Sets this.options.headerIcon which is reactive for application shells.

        +
      • set headerIcon(headerIcon: string): void

      • Sets this.options.headerIcon which is reactive for application shells.

        Parameters

        • headerIcon: string

          Sets the headerButtonNoLabel option.

          -

        Returns void

      headerNoTitleMinimized

      • get headerNoTitleMinimized(): boolean

      • Returns the headerNoTitleMinimized app option.

        +

      Returns void

      headerNoTitleMinimized

      • get headerNoTitleMinimized(): boolean

      • Returns the headerNoTitleMinimized app option.

        Returns boolean

        When true removes the header title when minimized.

        -
      • set headerNoTitleMinimized(headerNoTitleMinimized): void

      • Sets this.options.headerNoTitleMinimized which is reactive for application shells.

        +
      • set headerNoTitleMinimized(headerNoTitleMinimized: boolean): void

      • Sets this.options.headerNoTitleMinimized which is reactive for application shells.

        Parameters

        • headerNoTitleMinimized: boolean

          Sets the headerNoTitleMinimized option.

          -

        Returns void

      minimizable

      • get minimizable(): boolean

      • Returns the minimizable app option.

        +

      Returns void

      minimizable

      • get minimizable(): boolean

      • Returns the minimizable app option.

        Returns boolean

        Minimizable app option.

        -
      • set minimizable(minimizable): void

      • Sets this.options.minimizable which is reactive for application shells that are also pop out.

        +
      • set minimizable(minimizable: boolean): void

      • Sets this.options.minimizable which is reactive for application shells that are also pop out.

        Parameters

        • minimizable: boolean

          Sets the minimizable option.

          -

        Returns void

      minimized

      • get minimized(): boolean

      • Returns the current minimized UI state.

        +

      Returns void

      minimized

      • get minimized(): boolean

      • Returns the current minimized UI state.

        Returns boolean

        Minimized UI state.

        -

      popOut

      • get popOut(): boolean

      • Returns the Foundry popOut state; ApplicationOptions.popOut

        +

      popOut

      • get popOut(): boolean

      • Returns the Foundry popOut state; ApplicationOptions.popOut

        Returns boolean

        Positionable app option.

        -
      • set popOut(popOut): void

      • Sets this.options.popOut which is reactive for application shells. This will add / remove this application +

      • set popOut(popOut: boolean): void

      • Sets this.options.popOut which is reactive for application shells. This will add / remove this application from ui.windows.

        Parameters

        • popOut: boolean

          Sets the popOut option.

          -

        Returns void

      positionable

      Returns void

      positionable

      • get positionable(): boolean

      • Returns the positionable app option; SvelteApplicationOptions.positionable

        Returns boolean

        Positionable app option.

        -
      • set positionable(positionable): void

      • Sets this.options.positionable enabling / disabling SvelteApplication.position.

        +
      • set positionable(positionable: boolean): void

      • Sets this.options.positionable enabling / disabling SvelteApplication.position.

        Parameters

        • positionable: boolean

          Sets the positionable option.

          -

        Returns void

      resizable

      • get resizable(): boolean

      • Returns the resizable option.

        +

      Returns void

      resizable

      • get resizable(): boolean

      • Returns the resizable option.

        Returns boolean

        Resizable app option.

        -
      • set resizable(resizable): void

      • Sets this.options.resizable which is reactive for application shells.

        +
      • set resizable(resizable: boolean): void

      • Sets this.options.resizable which is reactive for application shells.

        Parameters

        • resizable: boolean

          Sets the resizable option.

          -

        Returns void

      resizing

      • get resizing(): boolean

      • Returns the current resizing UI state.

        +

      Returns void

      resizing

      • get resizing(): boolean

      • Returns the current resizing UI state.

        Returns boolean

        Resizing UI state.

        -

      sessionStorage

      storeAppOptions

      sessionStorage

      storeAppOptions

      storeUIState

      storeUIState

      title

      • get title(): string

      • Returns the title accessor from the parent Application class; ApplicationOptions.title

        +

      title

      • get title(): string

      • Returns the title accessor from the parent Application class; ApplicationOptions.title

        Returns string

        Title.

        -
      • set title(title): void

      • Sets this.options.title which is reactive for application shells.

        +
      • set title(title: string): 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: string, defaultValue?: any): 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.

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

        +

      mergeOptions

      • mergeOptions(options: object): 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.

          -

        Returns void

      setOptions

      • setOptions(accessor, value): void

      • Provides a way to safely set this applications options given an accessor string which describes the +

      Returns void

      setOptions

      • setOptions(accessor: string, value: any): void

      • Provides a way to safely set 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.

        Additionally, if an application shell Svelte component is mounted and exports the appOptions property then the application options is set to appOptions potentially updating the application shell / Svelte component.

        Parameters

        • accessor: string

          The path / key to set. You can set multiple levels.

        • value: any

          Value to set.

          -

        Returns void

      toJSON

      updateHeaderButtons

      • updateHeaderButtons(opts?): void

      • Updates the UI Options store with the current header buttons. You may dynamically add / remove header buttons +

      Returns void

      toJSON

      updateHeaderButtons

      • updateHeaderButtons(
            opts?: { headerButtonNoClose?: boolean; headerButtonNoLabel?: boolean },
        ): void

      • Updates the UI Options store with the current header buttons. You may dynamically add / remove header buttons if using an application shell Svelte component. In either overriding _getHeaderButtons or responding to the Hooks fired return a new button array and the uiOptions store is updated and the application shell will render the new buttons.

        -

        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 +

        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

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

      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 601f20e..701173c 100644 --- a/docs/interfaces/_runtime_svelte_application.TJSDialogData.html +++ b/docs/interfaces/_runtime_svelte_application.TJSDialogData.html @@ -1,109 +1,109 @@ -TJSDialogData | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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: {
              [key: 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 +
      interface TJSDialogData {
          get buttons(): { [key: string]: TJSDialogButtonData };
          set buttons(buttons: { [key: string]: TJSDialogButtonData }): void;
          get content(): string | TJSSvelteConfig;
          set content(content: string | TJSSvelteConfig): void;
          get default(): string;
          set default(newDefault: string): void;
          get draggable(): boolean;
          set draggable(draggable: boolean): void;
          get focusAuto(): boolean;
          set focusAuto(focusAuto: boolean): void;
          get focusFirst(): boolean;
          set focusFirst(focusFirst: boolean): void;
          get focusKeep(): boolean;
          set focusKeep(focusKeep: boolean): void;
          get minimizable(): boolean;
          set minimizable(minimizable: boolean): void;
          get modal(): boolean;
          set modal(modal: boolean): void;
          get modalOptions(): TJSDialogModalOptions;
          set modalOptions(modalOptions: TJSDialogModalOptions): void;
          get notifyError(): boolean;
          set notifyError(notifyError: boolean): void;
          get onClose(): string | (data?: { application?: TJSDialog }) => any;
          set onClose(
              onClose: string | (data?: { application?: TJSDialog }) => any,
          ): void;
          get rejectClose(): boolean;
          set rejectClose(rejectClose: boolean): void;
          get resizable(): boolean;
          set resizable(resizable: boolean): void;
          get resolveId(): boolean;
          set resolveId(resolveId: boolean): void;
          get title(): string;
          set title(title: string): void;
          get transition(): TJSDialogTransitionOptions;
          set transition(transition: TJSDialogTransitionOptions): void;
          get zIndex(): number;
          set zIndex(zIndex: number): void;
          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 -focusAuto -focusFirst -focusKeep +focusAuto +focusFirst +focusKeep minimizable modal -modalOptions -notifyError -onClose -rejectClose +modalOptions +notifyError +onClose +rejectClose resizable -resolveId +resolveId title transition -zIndex +zIndex

      Methods

      clone get merge replace set -

      Accessors

      buttons

      content

      • get content(): string | TJSSvelteConfig

      • Returns string | TJSSvelteConfig

        The Svelte configuration object or HTML string content.

        -
      • set content(content): void

      • Set the Svelte configuration object or HTML string content.

        -

        Parameters

        • content: string | TJSSvelteConfig

          New Svelte configuration object or HTML string content.

          -

        Returns void

      default

      • get default(): string

      • Returns string

        The default button ID to focus initially.

        -
      • set default(newDefault): void

      • Set the default button ID to focus initially.

        +

      Accessors

      buttons

      content

      • get content(): string | TJSSvelteConfig

      • Returns string | TJSSvelteConfig

        The Svelte configuration object or HTML string content.

        +
      • set content(content: string | TJSSvelteConfig): void

      • Set the Svelte configuration object or HTML string content.

        +

        Parameters

        • content: string | TJSSvelteConfig

          New Svelte configuration object or HTML string content.

          +

        Returns void

      default

      • get default(): string

      • Returns string

        The default button ID to focus initially.

        +
      • set default(newDefault: string): void

      • Set the default button ID to focus initially.

        Parameters

        • newDefault: string

          New default button ID to focus initially.

          -

        Returns void

      draggable

      • get draggable(): boolean

      • Returns boolean

        The dialog draggable state; draggable when true.

        -
      • set draggable(draggable): void

      • Set the dialog state; draggable when true.

        +

      Returns void

      draggable

      • get draggable(): boolean

      • Returns boolean

        The dialog draggable state; draggable when true.

        +
      • set draggable(draggable: boolean): void

      • Set the dialog state; draggable when true.

        Parameters

        • draggable: boolean

          New dialog draggable state; draggable when true.

          -

        Returns void

      focusAuto

      • get focusAuto(): boolean

      • Returns boolean

        When true auto-management of app focus is enabled.

        -
      • set focusAuto(focusAuto): void

      • Set the dialog auto-management of app focus.

        +

      Returns void

      focusAuto

      • get focusAuto(): boolean

      • Returns boolean

        When true auto-management of app focus is enabled.

        +
      • set focusAuto(focusAuto: boolean): void

      • Set the dialog auto-management of app focus.

        Parameters

        • focusAuto: boolean

          New dialog auto-management of app focus.

          -

        Returns void

      focusFirst

      • get focusFirst(): boolean

      • Returns boolean

        When true the first focusable element that isn't a button is focused.

        -
      • set focusFirst(focusFirst): void

      • Set the dialog first focusable element state.

        +

      Returns void

      focusFirst

      • get focusFirst(): boolean

      • Returns boolean

        When true the first focusable element that isn't a button is focused.

        +
      • set focusFirst(focusFirst: boolean): void

      • Set the dialog first focusable element state.

        Parameters

        • focusFirst: boolean

          New dialog first focusable element state.

          -

        Returns void

      focusKeep

      • get focusKeep(): boolean

      • Returns boolean

        When focusAuto and focusKeep is true; keeps internal focus.

        -
      • set focusKeep(focusKeep): void

      • Set the dialog focusKeep state. When focusAuto and focusKeep is true; keeps internal focus.

        +

      Returns void

      focusKeep

      • get focusKeep(): boolean

      • Returns boolean

        When focusAuto and focusKeep is true; keeps internal focus.

        +
      • set focusKeep(focusKeep: boolean): void

      • Set the dialog focusKeep state. When focusAuto and focusKeep is true; keeps internal focus.

        Parameters

        • focusKeep: boolean

          New dialog focusKeep state.

          -

        Returns void

      minimizable

      • get minimizable(): boolean

      • Returns boolean

        When true the dialog is minimizable.

        -
      • set minimizable(minimizable): void

      • Set the dialog minimizable state. When true the dialog is minimizable.

        +

      Returns void

      minimizable

      • get minimizable(): boolean

      • Returns boolean

        When true the dialog is minimizable.

        +
      • set minimizable(minimizable: boolean): void

      • Set the dialog minimizable state. When true the dialog is minimizable.

        Parameters

        • minimizable: boolean

          New dialog minimizable state.

          -

        Returns void

      modal

      • get modal(): boolean

      • Returns boolean

        When true a modal dialog is displayed.

        -
      • set modal(modal): void

      • Set the dialog modal state. When true a modal dialog is displayed.

        +

      Returns void

      modal

      • Returns boolean

        When true a modal dialog is displayed.

        +

      • Set the dialog modal state. When true a modal dialog is displayed.

        Parameters

        • modal: boolean

          New dialog modal state.

          -

        Returns void

      modalOptions

      Returns void

      modalOptions

      notifyError

      • get notifyError(): boolean

      • Returns boolean

        When true and an error is raised in dialog callback functions post a UI error notification.

        -
      • set notifyError(notifyError): void

      • Set the dialog notifyError state. When true and an error is raised in dialog callback functions post a UI error +

      Returns void

      notifyError

      • get notifyError(): boolean

      • Returns boolean

        When true and an error is raised in dialog callback functions post a UI error notification.

        +
      • set notifyError(notifyError: boolean): 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?: {
            application?: TJSDialog;
        }) => any)

      • Returns string | ((data?: {
            application?: TJSDialog;
        }) => any)

        Callback invoked when dialog is +

      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 +

      • set onClose(onClose: string | (data?: { application?: TJSDialog }) => any): 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?: {
              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 +

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

        -
      • set rejectClose(rejectClose): void

      • Set the dialog rejectClose state.

        +
      • set rejectClose(rejectClose: boolean): 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.

        +

      Returns void

      resizable

      • get resizable(): boolean

      • Returns boolean

        When true the dialog is resizable.

        +
      • set resizable(resizable: boolean): 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 +

      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.

        -
      • set resolveId(resolveId): void

      • Set the dialog resolveId state. When true and resolving any Promises and there are undefined results from any +

      • set resolveId(resolveId: boolean): 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.

          -

        Returns void

      title

      • get title(): string

      • Returns string

        The dialog window title.

        -
      • set title(title): void

      • Set the dialog window title.

        +

      Returns void

      title

      • get title(): string

      • Returns string

        The dialog window title.

        +
      • set title(title: string): void

      • Set the dialog window title.

        Parameters

        • title: string

          New dialog window title.

          -

        Returns void

      transition

      Returns void

      transition

      zIndex

      • get zIndex(): number

      • Returns number

        A specific z-index for the dialog. Pass null for the dialog to act like other +

      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.

        -
      • set zIndex(zIndex): void

      • Set specific z-index for the dialog.

        +
      • set zIndex(zIndex: number): 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 +

      get

      • get(accessor: string, defaultValue?: any): 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.

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

        +

      merge

      replace

      • replace(data: any): void

      • Replaces all dialog data; this is reactive.

        Parameters

        • data: any

          Dialog data.

          -

        Returns void

      set

      • set(accessor, value): boolean

      • Provides a way to safely set this dialogs data given an accessor string which describes the +

      Returns void

      set

      • set(accessor: string, value: any): boolean

      • Provides a way to safely set 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.

        Automatically the dialog data will be updated in the associated DialogShell Svelte component.

        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

      On This Page

      Accessors
      Methods
      \ 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_fvtt_document.EmbeddedAPI.html b/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html index bb30f13..7a44def 100644 --- a/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html +++ b/docs/interfaces/_runtime_svelte_store_fvtt_document.EmbeddedAPI.html @@ -1,13 +1,13 @@ -EmbeddedAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +EmbeddedAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface EmbeddedAPI

      Provides the public embedded reactive collection API.

      +
      interface EmbeddedAPI {
          create<T extends NamedDocumentConstructor>(
              doc: T,
              options: DynOptionsMapCreate<string, InstanceType<T>>,
          ): DynMapReducer<string, InstanceType<T>>;
          destroy<T extends NamedDocumentConstructor>(
              doc?: T,
              storeName?: string,
          ): boolean;
          get<T extends NamedDocumentConstructor>(
              doc: T,
              storeName: string,
          ): DynMapReducer<string, InstanceType<T>>;
      }

      Methods

      create destroy get -

      Methods

      create

      destroy

      • destroy<T>(doc?, storeName?): boolean
        • +

      Methods

      create

      destroy

      • destroy<T extends NamedDocumentConstructor>(
            doc?: T,
            storeName?: string,
        ): boolean
        • Destroys one or more embedded collection stores.
        -

        Type Parameters

        Parameters

        • Optionaldoc: T
        • OptionalstoreName: string

        Returns boolean

      get

      get

      Settings

      Member Visibility

      On This Page

      Methods
      \ 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 32c0967..9177a4a 100644 --- a/docs/interfaces/_runtime_svelte_store_fvtt_document.NamedDocumentConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_fvtt_document.NamedDocumentConstructor.html @@ -1,5 +1,5 @@ -NamedDocumentConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      ReadonlydocumentName

      documentName: string

      Settings

      Member Visibility

      On This Page

      Constructors
      Properties
      \ No newline at end of file +NamedDocumentConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface NamedDocumentConstructor

      Provides a basic duck type for Foundry documents. Expects a constructor / class w/ static property name.

      +
      interface NamedDocumentConstructor {
          new NamedDocumentConstructor(...args: any[]): any;
          documentName: string;
      }

      Constructors

      constructor +

      Properties

      documentName +

      Constructors

      constructor

      • new NamedDocumentConstructor(...args: any[]): any

      • Parameters

        • ...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_position.Action.DraggableOptionsStore.html b/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html index 9e6fc91..9f47713 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html +++ b/docs/interfaces/_runtime_svelte_store_position.Action.DraggableOptionsStore.html @@ -1,8 +1,8 @@ -DraggableOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +DraggableOptionsStore | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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: void, run: Subscriber<DraggableOptionsStore>, invalidate?: Invalidator<DraggableOptionsStore>): Unsubscriber;
      }
      +
      interface DraggableOptionsStore {
          tween: boolean;
          tweenOptions: QuickTweenOptions;
          get tweenDuration(): number;
          set tweenDuration(duration: number): void;
          get tweenEase(): EasingReference;
          set tweenEase(ease: EasingReference): void;
          reset(): void;
          resetTween(): void;
          resetTweenOptions(): void;
          subscribe(
              this: void,
              run: Subscriber<DraggableOptionsStore>,
              invalidate?: Invalidator<DraggableOptionsStore>,
          ): Unsubscriber;
      }
      @@ -10,26 +10,26 @@
      Hierarchy
      -
      +
      -

      Accessors

      tweenDuration -tweenEase +

      Accessors

      tweenDuration +tweenEase

      Methods

      reset -resetTween -resetTweenOptions +resetTween +resetTweenOptions subscribe

      Properties

      tween -tweenOptions -

      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

      resetTween

      • resetTween(): void

      • Resets tween enabled state to initial value.

        -

        Returns void

      resetTweenOptions

      • resetTweenOptions(): void

      • Resets tween options to initial values.

        -

        Returns void

      subscribe

      Accessors

      tweenDuration

      • get tweenDuration(): number

      • Returns number

        Get tween duration.

        +
      • set tweenDuration(duration: number): void

      • Parameters

        • duration: number

          Set tween duration.

          +

        Returns void

      tweenEase

      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.

      -

      tweenOptions

      tweenOptions: QuickTweenOptions

      Quick tween options for easing function and duration.

      -

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      Properties
      \ No newline at end of file +

      tweenOptions

      tweenOptions: QuickTweenOptions

      Quick tween options for easing function and duration.

      +

      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 deleted file mode 100644 index 1c27a67..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupDataCallback.html +++ /dev/null @@ -1,11 +0,0 @@ -GroupDataCallback | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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.

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

      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 deleted file mode 100644 index 5113c09..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickToCallback.html +++ /dev/null @@ -1,24 +0,0 @@ -GroupQuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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: QuickTweenOptions | GroupQuickTweenOptionsCallback) => GroupQuickToCallback);
          (arg: GroupDataCallback): void;
          (...args: (string | number)[]): void;
          (arg: Partial<{
              height: string | number;
              left: string | number;
              maxHeight: string | number;
              maxWidth: string | number;
              minHeight: string | number;
              minWidth: string | number;
              rotateX: string | number;
              rotateY: string | number;
              rotateZ: string | number;
              rotation: string | number;
              scale: string | number;
              top: string | number;
              translateX: string | number;
              translateY: string | number;
              translateZ: string | number;
              width: string | number;
              zIndex: string | number;
          }>): void;
      }
      -
      - -
      - - Hierarchy
      -       -
      -
      -
      -
      • 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<{
              height: string | number;
              left: string | number;
              maxHeight: string | number;
              maxWidth: string | number;
              minHeight: string | number;
              minWidth: string | number;
              rotateX: string | number;
              rotateY: string | number;
              rotateZ: string | number;
              rotation: string | number;
              scale: string | number;
              top: string | number;
              translateX: string | number;
              translateY: string | number;
              translateZ: string | number;
              width: string | number;
              zIndex: string | number;
          }>

          A single object with animation keys specified and numerical or relative string values.

          -

        Returns void

      Properties

      keys -options -

      Properties

      Readonlykeys

      keys: AnimationKey[]

      The keys assigned for this quickTo callback.

      -

      options

      options: ((options: QuickTweenOptions | GroupQuickTweenOptionsCallback) => GroupQuickToCallback)

      Sets options of quickTo tween.

      -

      Type declaration

      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 deleted file mode 100644 index 360f125..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupQuickTweenOptionsCallback.html +++ /dev/null @@ -1,10 +0,0 @@ -GroupQuickTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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.

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

      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 deleted file mode 100644 index b195a3f..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.GroupTweenOptionsCallback.html +++ /dev/null @@ -1,10 +0,0 @@ -GroupTweenOptionsCallback | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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.

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

      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 deleted file mode 100644 index 424ae81..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI-1.QuickToCallback.html +++ /dev/null @@ -1,22 +0,0 @@ -QuickToCallback | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface QuickToCallback

      The quickTo callback function returned from AnimationAPI.quickTo.

      -
      interface QuickToCallback {
          keys: AnimationKey[];
          options: ((options: QuickTweenOptions) => QuickToCallback);
          (...args: (string | number)[]): void;
          (arg: Partial<{
              height: string | number;
              left: string | number;
              maxHeight: string | number;
              maxWidth: string | number;
              minHeight: string | number;
              minWidth: string | number;
              rotateX: string | number;
              rotateY: string | number;
              rotateZ: string | number;
              rotation: string | number;
              scale: string | number;
              top: string | number;
              translateX: string | number;
              translateY: string | number;
              translateZ: string | number;
              width: string | number;
              zIndex: string | number;
          }>): void;
      }
      -
      - -
      - - Hierarchy
      -       -
      -
      -
      -
      • QuickToCallback(...args): void

      • Parameters

        • Rest...args: (string | number)[]

          Individual numbers or relative strings corresponding to the order in which animation keys are -specified.

          -

        Returns void

      • QuickToCallback(arg): void

      • Parameters

        • arg: Partial<{
              height: string | number;
              left: string | number;
              maxHeight: string | number;
              maxWidth: string | number;
              minHeight: string | number;
              minWidth: string | number;
              rotateX: string | number;
              rotateY: string | number;
              rotateZ: string | number;
              rotation: string | number;
              scale: string | number;
              top: string | number;
              translateX: string | number;
              translateY: string | number;
              translateZ: string | number;
              width: string | number;
              zIndex: string | number;
          }>

          A single object with animation keys specified and numerical or relative string values.

          -

        Returns void

      Properties

      keys -options -

      Properties

      Readonlykeys

      keys: AnimationKey[]

      The keys assigned for this quickTo callback.

      -

      options

      options: ((options: QuickTweenOptions) => QuickToCallback)

      Sets options of quickTo tween.

      -

      Type declaration

      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 db962c6..5f7c15d 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationAPI.html @@ -1,31 +1,31 @@ -AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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, any, any>, options?: QuickTweenOptions): QuickToCallback;
          to(toData: TJSPositionDataRelative, options?: TweenOptions): BasicAnimation;
      }

      Accessors

      isScheduled +AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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, any, any>,
              options?: QuickTweenOptions,
          ): QuickToCallback;
          to(toData: TJSPositionDataRelative, options?: TweenOptions): BasicAnimation;
      }

      Accessors

      isScheduled

      Methods

      cancel from -fromTo -getScheduled -quickTo +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.

        -

        Returns void

      from

      • from(fromData, options?): BasicAnimation

      • Provides a tween from given position data to the current position.

        +

      Methods

      cancel

      • cancel(): void

      • Cancels all animation instances for this TJSPosition instance.

        +

        Returns void

      from

      fromTo

      • fromTo(fromData, toData, options?): BasicAnimation

      • Provides a tween from given position data to the given position.

        +

      fromTo

      getScheduled

      • getScheduled(): BasicAnimation[]

      • Returns all currently scheduled AnimationControl instances for this TJSPosition instance.

        +

      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.

        +

      quickTo

      to

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ 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 6b400e5..01357d3 100644 --- a/docs/interfaces/_runtime_svelte_store_position.AnimationGroupAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.AnimationGroupAPI.html @@ -1,57 +1,57 @@ -AnimationGroupAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface AnimationGroupAPI

      Provides a public API for grouping multiple TJSPosition animations together and is accessible from -TJSPosition.Animate.

      -

      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, any, any>, options?: QuickTweenOptions | GroupQuickTweenOptionsCallback): GroupQuickToCallback;
          to(positionGroup: PositionGroup, toData: TJSPositionDataRelative | GroupDataCallback, options?: TweenOptions | GroupTweenOptionsCallback): BasicAnimation;
      }

      Methods

      cancel -cancelAll +AnimationGroupAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface AnimationGroupAPI

      Provides a public API for grouping multiple TJSPosition animations together and is accessible from +TJSPosition.Animate.

      +

      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, any, any>,
              options?: QuickTweenOptions | GroupQuickTweenOptionsCallback,
          ): GroupQuickToCallback;
          to(
              positionGroup: PositionGroup,
              toData: TJSPositionDataRelative | GroupDataCallback,
              options?: TweenOptions | GroupTweenOptionsCallback,
          ): BasicAnimation;
      }

      Methods

      cancel +cancelAll from -fromTo -getScheduled -isAnimationKey -isScheduled -quickTo +fromTo +getScheduled +isAnimationKey +isScheduled +quickTo to -

      Methods

      cancel

      • cancel(positionGroup): void

      • Cancels any animation for given PositionGroup data.

        +

      Methods

      cancel

      • cancel(positionGroup: 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.

        +

      Returns void

      cancelAll

      • cancelAll(): void

      • Cancels all TJSPosition animation.

        +

        Returns void

      from

      fromTo

      • fromTo(positionGroup, fromData, toData, options?): BasicAnimation

      • Provides the fromTo animation tween for one or more positionable instances as a group.

        +

      fromTo

      getScheduled

      • getScheduled(positionGroup): {
            controls: BasicAnimation[];
            entry: Positionable;
            position: TJSPosition;
        }[]

      • Gets all animation controls for the given position group data.

        +

      getScheduled

      isAnimationKey

      Returns { controls: BasicAnimation[]; entry: Positionable; position: TJSPosition }[]

      Results array.

      +

      isAnimationKey

      isScheduled

      • isScheduled(positionGroup, options?): boolean

      • Returns the status for the entire position group specified if all position instances of the group are scheduled.

        +

      Returns key is AnimationKey

      Whether the given key is an animation key.

      +

      isScheduled

      • isScheduled(positionGroup: PositionGroup, options?: ScheduleOptions): 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

      • quickTo(positionGroup, keys, options?): GroupQuickToCallback

      • Provides the quickTo animation tweening function for one or more positionable instances as a group.

        +

      quickTo

      to

      • to(positionGroup, toData, options?): BasicAnimation

      • Provides the to animation tween for one or more positionable instances as a group.

        +

      Returns GroupQuickToCallback

      quick-to tween function.

      +

      to

      Settings

      Member Visibility

      On This Page

      Methods
      \ 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 b25353b..41c3de2 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html +++ b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionData.html @@ -1,22 +1,22 @@ -TJSPositionData | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +TJSPositionData | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 left -maxHeight -maxWidth -minHeight -minWidth -rotateX -rotateY -rotateZ +maxHeight +maxWidth +minHeight +minWidth +rotateX +rotateY +rotateZ rotation scale top -transformOrigin -translateX -translateY -translateZ +transformOrigin +translateX +translateY +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

      On This Page

      Properties
      \ No newline at end of file +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

      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 bd9c57d..55d9bf7 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataConstructor.html @@ -1,4 +1,4 @@ -TJSPositionDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +TJSPositionDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface TJSPositionDataConstructor

      Defines the constructor function for TJSPositionData.

      +
      interface TJSPositionDataConstructor {
          new TJSPositionDataConstructor(
              __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?: {
                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

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

        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 d6927e1..d1404e5 100644 --- a/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataExtra.html +++ b/docs/interfaces/_runtime_svelte_store_position.Data.TJSPositionDataExtra.html @@ -1,6 +1,6 @@ -TJSPositionDataExtra | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +TJSPositionDataExtra | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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;
      }
      @@ -8,24 +8,24 @@
      Hierarchy
      -
      +

      Indexable

      • [key: string]: any

      Properties

      height? left? -maxHeight? -maxWidth? -minHeight? -minWidth? -rotateX? -rotateY? -rotateZ? +maxHeight? +maxWidth? +minHeight? +minWidth? +rotateX? +rotateY? +rotateZ? rotation? scale? top? -transformOrigin? -translateX? -translateY? -translateZ? +transformOrigin? +translateX? +translateY? +translateZ? width? -zIndex? -

      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 +zIndex? +

      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 8bd9eb6..9ba27cc 100644 --- a/docs/interfaces/_runtime_svelte_store_position.PositionStateAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.PositionStateAPI.html @@ -1,54 +1,54 @@ -PositionStateAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface PositionStateAPI

      interface PositionStateAPI {
          clear(): void;
          get(options: {
              name: string;
          }): TJSPositionDataExtra;
          getDefault(): TJSPositionDataExtra;
          keys(): IterableIterator<string, any, any>;
          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, any, any>;
              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 +PositionStateAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface PositionStateAPI

      interface PositionStateAPI {
          clear(): void;
          get(options: { name: string }): TJSPositionDataExtra;
          getDefault(): TJSPositionDataExtra;
          keys(): IterableIterator<string, any, any>;
          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, any, any>;
                  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 +getDefault keys remove reset restore save set -

      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.

            +

      Methods

      clear

      • clear(): void

      • Clears all saved position data except any default state.

        +

        Returns void

      get

      • get(options: { name: string }): TJSPositionDataExtra

      • Gets any stored saved position data by name.

        +

        Parameters

        • options: { name: string }

          Options.

          +
          • name: string

            Saved data name.

        Returns TJSPositionDataExtra

        Any saved position data.

        -

      getDefault

      getDefault

      keys

      remove

      • remove(options): TJSPositionDataExtra

      • Removes and returns any position data by name.

        -

        Parameters

        • options: {
              name: string;
          }

          Options.

          -
          • name: string

            Name to remove and retrieve.

            +

      keys

      remove

      • remove(options: { name: string }): TJSPositionDataExtra

      • Removes and returns any position data by name.

        +

        Parameters

        • options: { name: string }

          Options.

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

        • Optionaloptions: {
              invokeSet?: boolean;
              keepZIndex?: boolean;
          }

          Optional parameters.

          -
          • OptionalinvokeSet?: boolean

            When true invokes set method.

            -
          • OptionalkeepZIndex?: boolean

            When true keeps current z-index.

            +

      reset

      • reset(options?: { invokeSet?: boolean; keepZIndex?: boolean }): boolean

      • Resets position instance to default data and invokes set.

        +

        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

      • restore(
            options: {
                animateTo?: boolean;
                async?: boolean;
                duration?: number;
                ease?: EasingReference;
                name: string;
                properties?: Iterable<string, any, any>;
                remove?: boolean;
                silent?: boolean;
            },
        ): 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, any, any>;
              remove?: boolean;
              silent?: boolean;
          }

          Parameters

          -
          • OptionalanimateTo?: boolean

            Animate to restore data.

            -
          • Optionalasync?: boolean

            If animating return a Promise that resolves with any saved +

            Parameters

            • options: {
                  animateTo?: boolean;
                  async?: boolean;
                  duration?: number;
                  ease?: EasingReference;
                  name: string;
                  properties?: Iterable<string, any, any>;
                  remove?: boolean;
                  silent?: boolean;
              }

              Parameters

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

                -
              • Optionalproperties?: Iterable<string, any, any>

                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 +

      • Optionalduration?: number

        Duration in seconds.

        +
      • Optionalease?: EasingReference

        Easing function name or function.

        +
      • name: string

        Saved data set name.

        +
      • Optionalproperties?: Iterable<string, any, any>

        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.

      -

      save

      • save(options, optionsGet?): TJSPositionDataExtra

      • Saves current position state with the opportunity to add extra data to the saved state. Simply include +

      save

      • save(
            options: { name: string; [key: string]: any },
            optionsGet?: 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.

            +

            Parameters

            • options: { name: string; [key: string]: any }

              Options.

              +
              • [key: string]: any
              • name: string

                name to index this saved data.

            • 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

      On This Page

      Methods
      \ No newline at end of file +

      set

      • set(options: { name: string; [key: string]: any }): 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

      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 2ef5a5d..c9fcfd7 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystem.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystem.html @@ -1,6 +1,6 @@ -InitialSystem | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +InitialSystem | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface InitialSystem

      Provides helper functions to initially position an element.

      +
      interface InitialSystem {
          get constrain(): boolean;
          set constrain(constrain: boolean): void;
          get element(): HTMLElement;
          set element(element: HTMLElement): void;
          get enabled(): boolean;
          set enabled(enabled: boolean): void;
          get height(): number;
          set height(height: number): void;
          get locked(): boolean;
          get width(): number;
          set width(width: number): void;
          getLeft(width: number): number;
          getTop(height: number): number;
          setDimension(width: number, height: number): void;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Accessors

      constrain element @@ -16,27 +16,27 @@
      height locked width -

      Methods

      getLeft -getTop -setDimension -

      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

        Returns void

      enabled

      • get enabled(): boolean

      • Returns boolean

        Get enabled state.

        -
      • set enabled(enabled): void

      • Parameters

        • enabled: boolean

          Set enabled state.

          -

        Returns void

      height

      • get height(): number

      • Returns number

        Get manual height.

        -
      • set height(height): void

      • Parameters

        • height: number

          Set manual height.

          -

        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.

        +

      Methods

      getLeft +getTop +setDimension +

      Accessors

      constrain

      • get constrain(): boolean

      • Returns boolean

        The current constrain state.

        +
      • set constrain(constrain: boolean): void

      • Parameters

        • constrain: boolean

          Set constrain state.

          +

        Returns void

      element

      • get element(): HTMLElement

      • Returns HTMLElement

        Target element.

        +
      • set element(element: HTMLElement): void

      • Parameters

        Returns void

      enabled

      • get enabled(): boolean

      • Returns boolean

        Get enabled state.

        +
      • set enabled(enabled: boolean): void

      • Parameters

        • enabled: boolean

          Set enabled state.

          +

        Returns void

      height

      • get height(): number

      • Returns number

        Get manual height.

        +
      • set height(height: number): void

      • Parameters

        • height: number

          Set manual height.

          +

        Returns void

      locked

      • get locked(): boolean

      • Returns boolean

        Get locked state.

        +

      width

      • get width(): number

      • Returns number

        Get manual width.

        +
      • set width(width: number): void

      • Parameters

        • width: number

          Set manual width.

          +

        Returns void

      Methods

      getLeft

      • getLeft(width: number): number

      • Get the left constraint.

        Parameters

        • width: number

          Target width.

        Returns number

        Calculated left constraint.

        -

      getTop

      • getTop(height): number

      • Get the top constraint.

        +

      getTop

      • getTop(height: number): number

      • Get the top constraint.

        Parameters

        • height: number

          Target height.

        Returns number

        Calculated top constraint.

        -

      setDimension

      • setDimension(width, height): void

      • Set manual width & height.

        +

      setDimension

      • setDimension(width: number, height: number): void

      • Set manual width & height.

        Parameters

        • width: number

          New manual width.

        • height: number

          New manual height.

          -

        Returns void

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ 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 965805a..395f568 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystemConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Initial.InitialSystemConstructor.html @@ -1,11 +1,11 @@ -InitialSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +InitialSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface InitialSystemConstructor

      Describes the constructor function for an InitialSystem implementation.

      +
      interface InitialSystemConstructor {
          new InitialSystemConstructor(
              options?: {
                  constrain?: boolean;
                  element?: HTMLElement;
                  enabled?: boolean;
                  height?: number;
                  lock?: boolean;
                  width?: number;
              },
          ): InitialSystem;
      }

      Constructors

      constructor +

      Constructors

      constructor

      • new InitialSystemConstructor(
            options?: {
                constrain?: boolean;
                element?: HTMLElement;
                enabled?: boolean;
                height?: number;
                lock?: boolean;
                width?: number;
            },
        ): 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 6d861ae..94e858b 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.SystemBase.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.SystemBase.html @@ -1,5 +1,5 @@ -SystemBase | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface SystemBase

      interface SystemBase {
          constrain: boolean;
          element: HTMLElement;
          enabled: boolean;
          height: number;
          get locked(): boolean;
          width: number;
          setDimension(width: number, height: number): void;
      }
      +SystemBase | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface SystemBase

      interface SystemBase {
          get constrain(): boolean;
          set constrain(constrain: boolean): void;
          get element(): HTMLElement;
          set element(element: HTMLElement): void;
          get enabled(): boolean;
          set enabled(enabled: boolean): void;
          get height(): number;
          set height(height: number): void;
          get locked(): boolean;
          get width(): number;
          set width(width: number): void;
          setDimension(width: number, height: number): void;
      }
      @@ -7,7 +7,7 @@
      Hierarchy
      -
      +

      Accessors

      constrain element @@ -15,19 +15,19 @@
      height locked width -

      Methods

      setDimension -

      Accessors

      constrain

      • get constrain(): boolean

      • Returns boolean

        The current constrain state.

        -
      • set constrain(constrain): void

      • Parameters

        • constrain: boolean

          Set constrain state.

          -

        Returns void

      element

      enabled

      • get enabled(): boolean

      • Returns boolean

        Get enabled state.

        -
      • set enabled(enabled): void

      • Parameters

        • enabled: boolean

          Set enabled state.

          -

        Returns void

      height

      • get height(): number

      • Returns number

        Get manual height.

        -
      • set height(height): void

      • Parameters

        • height: number

          Set manual height.

          -

        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.

        +

      Methods

      setDimension +

      Accessors

      constrain

      • get constrain(): boolean

      • Returns boolean

        The current constrain state.

        +
      • set constrain(constrain: boolean): void

      • Parameters

        • constrain: boolean

          Set constrain state.

          +

        Returns void

      element

      enabled

      • get enabled(): boolean

      • Returns boolean

        Get enabled state.

        +
      • set enabled(enabled: boolean): void

      • Parameters

        • enabled: boolean

          Set enabled state.

          +

        Returns void

      height

      • get height(): number

      • Returns number

        Get manual height.

        +
      • set height(height: number): void

      • Parameters

        • height: number

          Set manual height.

          +

        Returns void

      locked

      • get locked(): boolean

      • Returns boolean

        Get locked state.

        +

      width

      • get width(): number

      • Returns number

        Get manual width.

        +
      • set width(width: number): void

      • Parameters

        • width: number

          Set manual width.

          +

        Returns void

      Methods

      setDimension

      • setDimension(width: number, height: number): void

      • Set manual width & height.

        Parameters

        • width: number

          New manual width.

        • height: number

          New manual height.

          -

        Returns void

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ 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 1a05a2c..bcdc0c4 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.SystemBaseConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.SystemBaseConstructor.html @@ -1,11 +1,11 @@ -SystemBaseConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +SystemBaseConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface SystemBaseConstructor

      Describes the constructor function for anu SystemBase implementation.

      +
      interface SystemBaseConstructor {
          new SystemBaseConstructor(
              options?: {
                  constrain?: boolean;
                  element?: HTMLElement;
                  enabled?: boolean;
                  height?: number;
                  lock?: boolean;
                  width?: number;
              },
          ): SystemBase;
      }

      Constructors

      constructor +

      Constructors

      constructor

      • new SystemBaseConstructor(
            options?: {
                constrain?: boolean;
                element?: HTMLElement;
                enabled?: boolean;
                height?: number;
                lock?: boolean;
                width?: number;
            },
        ): 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 f034f86..57008ec 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystem.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystem.html @@ -1,6 +1,6 @@ -ValidatorSystem | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +ValidatorSystem | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ValidatorSystem

      Provides a system to validate positional changes.

      +
      interface ValidatorSystem {
          id?: any;
          validate: ValidatorFn;
          weight?: number;
          get constrain(): boolean;
          set constrain(constrain: boolean): void;
          get element(): HTMLElement;
          set element(element: HTMLElement): void;
          get enabled(): boolean;
          set enabled(enabled: boolean): void;
          get height(): number;
          set height(height: number): void;
          get locked(): boolean;
          get width(): number;
          set width(width: number): void;
          setDimension(width: number, height: number): void;
          subscribe(
              this: void,
              run: Subscriber<any>,
              invalidate?: Invalidator<any>,
          ): Unsubscriber;
      }
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Accessors

      constrain element @@ -16,31 +16,31 @@
      height locked width -

      Methods

      setDimension +

      Methods

      setDimension subscribe?

      Properties

      id? validate weight? -

      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

        Returns void

      enabled

      • get enabled(): boolean

      • Returns boolean

        Get enabled state.

        -
      • set enabled(enabled): void

      • Parameters

        • enabled: boolean

          Set enabled state.

          -

        Returns void

      height

      • get height(): number

      • Returns number

        Get manual height.

        -
      • set height(height): void

      • Parameters

        • height: number

          Set manual height.

          -

        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.

        +

      Accessors

      constrain

      • get constrain(): boolean

      • Returns boolean

        The current constrain state.

        +
      • set constrain(constrain: boolean): void

      • Parameters

        • constrain: boolean

          Set constrain state.

          +

        Returns void

      element

      • get element(): HTMLElement

      • Returns HTMLElement

        Target element.

        +
      • set element(element: HTMLElement): void

      • Parameters

        Returns void

      enabled

      • get enabled(): boolean

      • Returns boolean

        Get enabled state.

        +
      • set enabled(enabled: boolean): void

      • Parameters

        • enabled: boolean

          Set enabled state.

          +

        Returns void

      height

      • get height(): number

      • Returns number

        Get manual height.

        +
      • set height(height: number): void

      • Parameters

        • height: number

          Set manual height.

          +

        Returns void

      locked

      • get locked(): boolean

      • Returns boolean

        Get locked state.

        +

      width

      • get width(): number

      • Returns number

        Get manual width.

        +
      • set width(width: number): void

      • Parameters

        • width: number

          Set manual width.

          +

        Returns void

      Methods

      setDimension

      • setDimension(width: number, height: number): void

      • Set manual width & height.

        Parameters

        • width: number

          New manual width.

        • height: number

          New manual height.

          -

        Returns void

      Optionalsubscribe

      • subscribe(this, run, invalidate?): Unsubscriber

      • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will +

      Returns void

      Optionalsubscribe

      • subscribe(
            this: void,
            run: Subscriber<any>,
            invalidate?: Invalidator<any>,
        ): Unsubscriber

      • Optional subscribe function following the Svelte store / subscribe pattern. On updates validation will be processed again.

        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 +

      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.

      +

      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 +

      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 2a7c37c..a563fee 100644 --- a/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystemConstructor.html +++ b/docs/interfaces/_runtime_svelte_store_position.System.Validator.ValidatorSystemConstructor.html @@ -1,11 +1,11 @@ -ValidatorSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +ValidatorSystemConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ValidatorSystemConstructor

      Describes the constructor function for an ValidatorSystem implementation.

      +
      interface ValidatorSystemConstructor {
          new ValidatorSystemConstructor(
              options?: {
                  constrain?: boolean;
                  element?: HTMLElement;
                  enabled?: boolean;
                  height?: number;
                  lock?: boolean;
                  width?: number;
              },
          ): ValidatorSystem;
      }

      Constructors

      constructor +

      Constructors

      constructor

      • new ValidatorSystemConstructor(
            options?: {
                constrain?: boolean;
                element?: HTMLElement;
                enabled?: boolean;
                height?: number;
                lock?: boolean;
                width?: number;
            },
        ): 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 b660a67..7c679c2 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.Positionable.html +++ b/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.Positionable.html @@ -1,6 +1,6 @@ -Positionable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Positionable

      Defines the shape of an instance / object that is positionable.

      -
      interface Positionable {
          position: TJSPosition;
      }
      +Positionable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Positionable

      Defines the shape of an instance / object that is positionable.

      +
      interface Positionable {
          position: TJSPosition;
      }
      @@ -11,4 +11,4 @@

      Properties

      position -

      Properties

      position

      position: TJSPosition

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +

      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 57d8b31..d7e8971 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html +++ b/docs/interfaces/_runtime_svelte_store_position.TJSPositionTypes.TJSPositionWritable.html @@ -1,6 +1,6 @@ -TJSPositionWritable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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;
      }
      +TJSPositionWritable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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;
      }
      @@ -18,16 +18,16 @@
      Hierarchy
      -
      +

      Methods

      set subscribe update -

      Methods

      set

      • set(this, value, options?): TJSPosition

      • Set value and inform subscribers.

        +

      Methods

      set

      subscribe

      Returns TJSPosition

      subscribe

      update

      • update(this, updater): void

      • Update value using callback and inform subscribers.

        +

      Returns Unsubscriber

      update

      Settings

      Member Visibility

      On This Page

      Methods
      \ 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 deleted file mode 100644 index 6fb3e77..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformData.html +++ /dev/null @@ -1,13 +0,0 @@ -TransformData | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      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

      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 deleted file mode 100644 index ffe4498..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformDataConstructor.html +++ /dev/null @@ -1,4 +0,0 @@ -TransformDataConstructor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 deleted file mode 100644 index df3a38a..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI-1.TransformOriginWritable.html +++ /dev/null @@ -1,25 +0,0 @@ -TransformOriginWritable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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: void, value: TransformOrigin): void;
          subscribe(this: void, run: Subscriber<TransformOrigin>, invalidate?: Invalidator<TransformOrigin>): Unsubscriber;
          update(this: void, updater: Updater<TransformOrigin>): void;
      }
      -
      - -
      - - Hierarchy
      -       -
      -
      -
      -

      Accessors

      values -

      Methods

      set -subscribe -update -

      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

      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 e52e31f..07543b0 100644 --- a/docs/interfaces/_runtime_svelte_store_position.TransformAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.TransformAPI.html @@ -1,72 +1,72 @@ -TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface TransformAPI

      interface TransformAPI {
          get isActive(): boolean;
          get rotateX(): number;
          set rotateX(value: number): void;
          get rotateY(): number;
          set rotateY(value: number): void;
          get rotateZ(): number;
          set rotateZ(value: number): void;
          get scale(): number;
          set scale(value: number): void;
          get translateX(): number;
          set translateX(value: number): void;
          get translateY(): number;
          set translateY(value: number): void;
          get translateZ(): number;
          set translateZ(value: number): void;
          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 scale -translateX -translateY -translateZ -

      Methods

      getCSS -getCSSOrtho -getData -getMat4 -getMat4Ortho -hasTransform +translateX +translateY +translateZ +

      Methods

      getCSS +getCSSOrtho +getData +getMat4 +getMat4Ortho +hasTransform reset -

      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.

        +

      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: number): 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.

          -

        Returns void

      rotateY

      • get rotateY(): number

      • Returns number

        Any local rotateY data.

        -
      • set rotateY(value): void

      • Sets the local rotateY data if the value is a finite number otherwise removes the local data.

        +

      Returns void

      rotateY

      • get rotateY(): number

      • Returns number

        Any local rotateY data.

        +
      • set rotateY(value: number): void

      • Sets the local rotateY data if the value is a finite number otherwise removes the local data.

        Parameters

        • value: number

          A value to set.

          -

        Returns void

      rotateZ

      • get rotateZ(): number

      • Returns number

        Any local rotateZ data.

        -
      • set rotateZ(value): void

      • Sets the local rotateZ data if the value is a finite number otherwise removes the local data.

        +

      Returns void

      rotateZ

      • get rotateZ(): number

      • Returns number

        Any local rotateZ data.

        +
      • set rotateZ(value: number): void

      • Sets the local rotateZ data if the value is a finite number otherwise removes the local data.

        Parameters

        • value: number

          A value to set.

          -

        Returns void

      scale

      • get scale(): number

      • Returns number

        Any local scale data.

        -
      • set scale(value): void

      • Sets the local scale data if the value is a finite number otherwise removes the local data.

        +

      Returns void

      scale

      • get scale(): number

      • Returns number

        Any local scale data.

        +
      • set scale(value: number): void

      • Sets the local scale data if the value is a finite number otherwise removes the local data.

        Parameters

        • value: number

          A value to set.

          -

        Returns void

      translateX

      • get translateX(): number

      • Returns number

        Any local translateX data.

        -
      • set translateX(value): void

      • Sets the local translateX data if the value is a finite number otherwise removes the local data.

        +

      Returns void

      translateX

      • get translateX(): number

      • Returns number

        Any local translateX data.

        +
      • set translateX(value: number): void

      • Sets the local translateX data if the value is a finite number otherwise removes the local data.

        Parameters

        • value: number

          A value to set.

          -

        Returns void

      translateY

      • get translateY(): number

      • Returns number

        Any local translateY data.

        -
      • set translateY(value): void

      • Sets the local translateY data if the value is a finite number otherwise removes the local data.

        +

      Returns void

      translateY

      • get translateY(): number

      • Returns number

        Any local translateY data.

        +
      • set translateY(value: number): void

      • Sets the local translateY data if the value is a finite number otherwise removes the local data.

        Parameters

        • value: number

          A value to set.

          -

        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.

        +

      Returns void

      translateZ

      • get translateZ(): number

      • Returns number

        Any local translateZ data.

        +
      • set translateZ(value: number): 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.

        +

      Returns void

      Methods

      getCSS

      • getCSS(data?: object): 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.

        +

      getCSSOrtho

      • getCSSOrtho(data?: object): 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.

        -

      getData

      • getData(position, output?, validationData?): TransformData

      • Collects all data including a bounding rect, transform matrix, and points array of the given +

      getData

      • getData(
            position: TJSPositionData,
            output?: TransformData,
            validationData?: object,
        ): 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.

          -
        • Optionaloutput: TransformData

          Optional TransformAPI.Data output instance.

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

        +

      Returns TransformData

      The output TransformAPI.Data instance.

      +

      getMat4

      • getMat4(data?: object, output?: Mat4): 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

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

        +
      • Optionaloutput: Mat4

        The output mat4 instance.

        +

      Returns Mat4

      Transform matrix.

      +

      getMat4Ortho

      • getMat4Ortho(data?: object, output?: Mat4): 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 from passed in data to translate X / Y.

        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

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

        +
      • Optionaloutput: Mat4

        The output mat4 instance.

        +

      Returns Mat4

      Transform matrix.

      +

      hasTransform

      • hasTransform(data: object): 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.

        +

      reset

      • reset(data: object): 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

      On This Page

      Accessors
      Methods
      \ 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 deleted file mode 100644 index 8487027..0000000 --- a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorFn.html +++ /dev/null @@ -1,45 +0,0 @@ -ValidatorFn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface ValidatorFn

      interface ValidatorFn {
          arguments: any;
          caller: Function;
          length: number;
          name: string;
          prototype: any;
          [hasInstance](value: any): boolean;
          apply(this: Function, thisArg: any, argArray?: any): any;
          bind(this: Function, thisArg: any, ...argArray: any[]): any;
          call(this: Function, thisArg: any, ...argArray: any[]): any;
          subscribe?(this: void, run: Subscriber<any>, invalidate?: Invalidator<any>): Unsubscriber;
          toString(): string;
          (data: ValidationData): TJSPositionData;
      }
      -
      - -
      - - Hierarchy
      -       -
      -
      -
      -
      • ValidatorFn(data): TJSPositionData

      • TJSPosition validator function that takes a ValidationData instance potentially modifying position -data or returning null if invalid.

        -

        Parameters

        Returns TJSPositionData

        The validated position data or null to cancel position update.

        -

      Methods

      [hasInstance] -apply -bind -call -subscribe? -toString -

      Properties

      arguments -caller -length -name -prototype -

      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.

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

          -

        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

      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

      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 c7e8803..fdcabb2 100644 --- a/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.html +++ b/docs/interfaces/_runtime_svelte_store_position.ValidatorAPI.html @@ -1,29 +1,29 @@ -ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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

      +

      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 +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, any, any>;
          add(...validators: (ValidatorData | ValidatorFn)[]): void;
          clear(): void;
          remove(...validators: (ValidatorData | ValidatorFn)[]): void;
          removeBy(callback: RemoveByCallback): void;
          removeById(...ids: any[]): void;
      }

      Accessors

      enabled +
      interface ValidatorAPI {
          get enabled(): boolean;
          set enabled(enabled: boolean): void;
          get length(): number;
          "[iterator]"(): IterableIterator<ValidatorData, any, any>;
          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] +

      Methods

      [iterator] add clear remove -removeBy -removeById -

      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]

      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

        Returns void

      removeBy

      • removeBy(callback): void

      • Remove validators by the provided callback. The callback takes 3 parameters: id, validator, and weight. +removeBy +removeById +

      Accessors

      enabled

      • get enabled(): boolean

      • Returns boolean

        Returns the enabled state.

        +
      • set enabled(enabled: boolean): void

      • Parameters

        • enabled: boolean

          Sets enabled state.

          +

        Returns void

      length

      • get length(): number

      • Returns number

        Returns the length of the validators array.

        +

      Methods

      [iterator]

      add

      clear

      • clear(): void

      • Clears / removes all validators.

        +

        Returns void

      remove

      removeBy

      • removeBy(callback: RemoveByCallback): 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

      On This Page

      Accessors
      Methods
      \ No newline at end of file +

      Parameters

      Returns void

      removeById

      • removeById(...ids: any[]): void

      • Removes any validators with matching IDs.

        +

        Parameters

        • ...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.DynAdapterFilters.html b/docs/interfaces/_runtime_svelte_store_reducer.DynAdapterFilters.html index f2d0899..5e62531 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynAdapterFilters.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynAdapterFilters.html @@ -1,5 +1,5 @@ -DynAdapterFilters | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynAdapterFilters<T>

      Provides the storage and sequencing of managed filters. Each filter added may be a bespoke function or a +DynAdapterFilters | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Interface DynAdapterFilters<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 @@ -13,21 +13,21 @@ 

      const dynArray = new DynArrayReducer([...]);
      dynArray.filters.add(...);
      dynArray.filters.clear();
      dynArray.filters.length;
      dynArray.filters.remove(...);
      dynArray.filters.removeBy(...);
      dynArray.filters.removeById(...);
      -
      interface DynAdapterFilters<T> {
          get length(): number;
          [iterator](): void | IterableIterator<DynDataFilter<T>, any, any>;
          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] +
      interface DynAdapterFilters<T> {
          get length(): number;
          "[iterator]"(): void | IterableIterator<DynDataFilter<T>, any, any>;
          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

        Returns void

      clear

      • clear(): void

      • Clears and removes all filters.

        -

        Returns void

      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. +removeBy +removeById +

      Accessors

      length

      • get length(): number

      • Returns number

        Returns the length of the filter data.

        +

      Methods

      [iterator]

      add

      clear

      • clear(): void

      • Clears and removes all filters.

        +

        Returns void

      remove

      removeBy

      • removeBy(
            callback: (id: any, filter: DynFilterFn<T>, weight: number) => boolean,
        ): 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: any, filter: DynFilterFn<T>, weight: number) => boolean)

          Callback function to evaluate +

          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 +

      Returns void

      removeById

      • removeById(...ids: any[]): void

      • Parameters

        • ...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.DynAdapterSort.html b/docs/interfaces/_runtime_svelte_store_reducer.DynAdapterSort.html index 4214c86..09bfc65 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynAdapterSort.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynAdapterSort.html @@ -1,5 +1,5 @@ -DynAdapterSort | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynAdapterSort<T>

      Provides the storage and sequencing of a managed sort function. The sort function set may be a bespoke function or a +DynAdapterSort | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Interface DynAdapterSort<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. @@ -9,11 +9,11 @@ 

      const dynArray = new DynArrayReducer([...]);
      dynArray.sort.clear();
      dynArray.sort.set(...);
      -
      interface DynAdapterSort<T> {
          clear(): void;
          set(sort: DynCompareFn<T> | DynDataSort<T>): void;
      }

      Type Parameters

      • T

      Methods

      clear +
      interface DynAdapterSort<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.

        -

        Returns void

      set

      • set(sort): void

      • Parameters

      Methods

      clear

      • clear(): void

      • Clears & removes any assigned sort function and triggers an index update.

        +

        Returns void

      set

      Settings

      Member Visibility

      On This Page

      Methods
      \ 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.DynArrayReducerCtor.html b/docs/interfaces/_runtime_svelte_store_reducer.DynArrayReducerCtor.html index d49955d..f6b2876 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynArrayReducerCtor.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynArrayReducerCtor.html @@ -1,4 +1,4 @@ -DynArrayReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynArrayReducerCtor<T>

      Defines the shape of a dynamic array constructor function.

      -
      interface DynArrayReducerCtor<T> {
          new DynArrayReducerCtornew (data?: Iterable<T, any, any> | DynArrayData<T>): DynArrayReducer<T>;
      }

      Type Parameters

      • T

      Constructors

      constructor -

      Constructors

      constructor

      Settings

      Member Visibility

      On This Page

      Constructors
      \ No newline at end of file +DynArrayReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DynArrayReducerCtor<T>

      Defines the shape of a dynamic array constructor function.

      +
      interface DynArrayReducerCtor<T> {
          new DynArrayReducerCtor(
              data?: Iterable<T, any, any> | 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.DynDerivedAPI.html b/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedAPI.html index e79c909..5a11835 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedAPI.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedAPI.html @@ -1,24 +1,24 @@ -DynDerivedAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynDerivedAPI<D, K, T>

      Provides the public API for derived reducers. There are several ways to create a derived reducer from utilizing the +DynDerivedAPI | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      Interface DynDerivedAPI<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(...);
      -

      Template: D,

      K, T

      -
      interface DynDerivedAPI<D, K, T> {
          clear(): void;
          create(options: DynOptionsDerivedCreate<T>): DynDerivedReducer<D, K, T>;
          delete(name: string): boolean;
          destroy(): void;
          get(name: string): DynDerivedReducer<D, K, T>;
      }

      Type Parameters

      • D
      • K
      • T

      Methods

      clear +

      Template: D,

      K, T

      +
      interface DynDerivedAPI<D, K, T> {
          clear(): void;
          create(options: DynOptionsDerivedCreate<T>): DynDerivedReducer<D, K, T>;
          delete(name: string): boolean;
          destroy(): void;
          get(name: string): DynDerivedReducer<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.

        -

        Returns void

      create

      delete

      • delete(name): boolean

      • Deletes and destroys a derived reducer.

        +

      Methods

      clear

      • clear(): void

      • Removes all derived reducers and associated subscriptions.

        +

        Returns void

      create

      delete

      • delete(name: string): boolean

      • Deletes and destroys a derived reducer.

        Parameters

        • name: string

          Name of the derived reducer

        Returns boolean

        Whether the derived reducer was deleted.

        -

      destroy

      • destroy(): void

      • Removes all derived reducers, associated subscriptions, and cleans up all resources.

        -

        Returns void

      get

      destroy

      • destroy(): void

      • Removes all derived reducers, associated subscriptions, and cleans up all resources.

        +

        Returns void

      get

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file +

      Returns DynDerivedReducer<D, K, T>

      Any associated derived reducer.

      +

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducer.html b/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducer.html index c3118b8..864865b 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducer.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducer.html @@ -1,6 +1,6 @@ -DynDerivedReducer | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynDerivedReducer<D, K, T>

      Defines the interface for a derived reducer.

      -
      interface DynDerivedReducer<D, K, T> {
          get data(): D;
          get derived(): DynDerivedAPI<D, K, T>;
          get destroyed(): boolean;
          get filters(): DynAdapterFilters<T>;
          get index(): DynIndexerAPI<K, T>;
          get length(): number;
          reversed: boolean;
          get sort(): DynAdapterSort<T>;
          destroy(): void;
          subscribe(handler: ((value: DynDerivedReducer<D, K, T>) => void)): (() => void);
      }

      Type Parameters

      • D
      • K
      • T
      +DynDerivedReducer | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DynDerivedReducer<D, K, T>

      Defines the interface for a derived reducer.

      +
      interface DynDerivedReducer<D, K, T> {
          get data(): D;
          get derived(): DynDerivedAPI<D, K, T>;
          get destroyed(): boolean;
          get filters(): DynAdapterFilters<T>;
          get index(): DynIndexerAPI<K, T>;
          get length(): number;
          get reversed(): boolean;
          set reversed(reversed: boolean): void;
          get sort(): DynAdapterSort<T>;
          destroy(): void;
          subscribe(handler: (value: DynDerivedReducer<D, K, T>) => void): () => void;
      }

      Type Parameters

      • D
      • K
      • T
      @@ -20,22 +20,22 @@
      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 DynDerivedReducer.index with true to recalculate the index and notify all subscribers.

        -

        Returns D

        The internal data.

        -

      derived

      destroyed

      • get destroyed(): boolean

      • Returns whether this derived reducer is destroyed.

        -

        Returns boolean

      filters

      index

      length

      • get length(): number

      • Returns number

        Main data / items length or indexed length.

        -

      reversed

      • get reversed(): boolean

      • Returns boolean

        Gets current reversed state.

        -
      • set reversed(reversed): void

      • Sets reversed state and notifies subscribers.

        +

        Returns D

        The internal data.

        +

      derived

      destroyed

      • get destroyed(): boolean

      • Returns whether this derived reducer is destroyed.

        +

        Returns boolean

      filters

      index

      length

      • get length(): number

      • Returns number

        Main data / items length or indexed length.

        +

      reversed

      • get reversed(): boolean

      • Returns boolean

        Gets current reversed state.

        +
      • set reversed(reversed: boolean): 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.

        -

        Returns void

      subscribe

      • subscribe(handler): (() => void)

      • Subscribe to this IDerivedReducer.

        -

        Parameters

        • handler: ((value: DynDerivedReducer<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

      On This Page

      Accessors
      Methods
      \ No newline at end of file +

      Returns void

      sort

      Methods

      destroy

      • destroy(): void

      • Removes all derived reducers, subscriptions, and cleans up all resources.

        +

        Returns void

      subscribe

      • subscribe(handler: (value: DynDerivedReducer<D, K, T>) => void): () => void

      • Subscribe to this IDerivedReducer.

        +

        Parameters

        • handler: (value: DynDerivedReducer<D, K, T>) => void

          Callback function that is invoked on update / changes. Receives derived reducer reference.

          +

        Returns () => void

        Unsubscribe function.

        +

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducerCtor.html b/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducerCtor.html index bafecfe..7f499be 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducerCtor.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynDerivedReducerCtor.html @@ -1,4 +1,4 @@ -DynDerivedReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynDerivedReducerCtor<T>

      Defines the shape of a derived reducer constructor function.

      -
      interface DynDerivedReducerCtor<T> {
          new DynDerivedReducerCtornew (hostData: DynDataHost<any>, parentIndex: DynIndexerAPI<any, T>, options: DynDataOptions<T>): DynDerivedReducer<any, any, T>;
      }

      Type Parameters

      • T

      Constructors

      constructor -

      Constructors

      constructor

      Settings

      Member Visibility

      On This Page

      Constructors
      \ No newline at end of file +DynDerivedReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DynDerivedReducerCtor<T>

      Defines the shape of a derived reducer constructor function.

      +
      interface DynDerivedReducerCtor<T> {
          new DynDerivedReducerCtor(
              hostData: DynDataHost<any>,
              parentIndex: DynIndexerAPI<any, T>,
              options: DynDataOptions<T>,
          ): DynDerivedReducer<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.DynIndexerAPI.html b/docs/interfaces/_runtime_svelte_store_reducer.DynIndexerAPI.html index b833622..4d27752 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynIndexerAPI.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynIndexerAPI.html @@ -1,20 +1,20 @@ -DynIndexerAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynIndexerAPI<K, T>

      Provides the public API for accessing the index API.

      +DynIndexerAPI | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DynIndexerAPI<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(...);
      -

      Template: K,

      T

      -
      interface DynIndexerAPI<K, T> {
          get active(): boolean;
          get hash(): number;
          get length(): number;
          [iterator](): IterableIterator<K, any, any>;
          update(force?: boolean): void;
      }

      Type Parameters

      • K
      • T

      Accessors

      active +

      Template: K,

      T

      +
      interface DynIndexerAPI<K, T> {
          get active(): boolean;
          get hash(): number;
          get length(): number;
          "[iterator]"(): IterableIterator<K, any, any>;
          update(force?: boolean): void;
      }

      Type Parameters

      • K
      • T

      Accessors

      active hash length -

      Methods

      [iterator] +

      Methods

      [iterator] update -

      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]

      update

      • update(force?): void

      • Manually invoke an update of the index.

        +

      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]

      update

      • update(force?: boolean): 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 +

      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.DynMapReducerCtor.html b/docs/interfaces/_runtime_svelte_store_reducer.DynMapReducerCtor.html index b0b6e64..b4a6ccc 100644 --- a/docs/interfaces/_runtime_svelte_store_reducer.DynMapReducerCtor.html +++ b/docs/interfaces/_runtime_svelte_store_reducer.DynMapReducerCtor.html @@ -1,4 +1,4 @@ -DynMapReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DynMapReducerCtor<K, T>

      Defines the shape of a dynamic map constructor function.

      -
      interface DynMapReducerCtor<K, T> {
          new DynMapReducerCtornew (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 +DynMapReducerCtor | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DynMapReducerCtor<K, T>

      Defines the shape of a dynamic map constructor function.

      +
      interface DynMapReducerCtor<K, T> {
          new DynMapReducerCtor(
              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_svelte_store_util.MinimalWritable.html b/docs/interfaces/_runtime_svelte_store_util.MinimalWritable.html index 5664827..427762b 100644 --- a/docs/interfaces/_runtime_svelte_store_util.MinimalWritable.html +++ b/docs/interfaces/_runtime_svelte_store_util.MinimalWritable.html @@ -1,8 +1,8 @@ -MinimalWritable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface MinimalWritable<T>

      The minimal requirements of the writable store contract.

      +MinimalWritable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface MinimalWritable<T>

      The minimal requirements of the writable store contract.

      A minimal writable is a Readable / subscribable, but only has a set method omitting the update method from Writable.

      -
      interface MinimalWritable<T> {
          set(this: void, value: T): void;
          subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
      }

      Type Parameters

      • T
      +
      interface MinimalWritable<T> {
          set(this: void, value: T): void;
          subscribe(
              this: void,
              run: Subscriber<T>,
              invalidate?: Invalidator<T>,
          ): Unsubscriber;
      }

      Type Parameters

      • T
      @@ -10,13 +10,13 @@
      Hierarchy
      -
      +

      Methods

      set subscribe -

      Methods

      set

      • set(this, value): void

      • Set value and inform subscribers.

        -

        Parameters

        • this: void
        • value: T

          to set

          -

        Returns void

      subscribe

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file +

      Methods

      set

      • set(this: void, value: T): void

      • Set value and inform subscribers.

        +

        Parameters

        • this: void
        • value: T

          to set

          +

        Returns void

      subscribe

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_svelte_store_web_storage.WebStorage.html b/docs/interfaces/_runtime_svelte_store_web_storage.WebStorage.html deleted file mode 100644 index 431d321..0000000 --- a/docs/interfaces/_runtime_svelte_store_web_storage.WebStorage.html +++ /dev/null @@ -1,49 +0,0 @@ -WebStorage | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface WebStorage

      Provides the TRL web storage store API.

      -
      interface WebStorage {
          entries<T>(regex?: RegExp): IterableIterator<[string, Writable<T>], any, any>;
          getItem(key: string, defaultValue?: any): unknown;
          getStore<T>(key: string, defaultValue?: T, storageStores?: StorageStores): Writable<T>;
          hasStore(key: string): boolean;
          keys(regex?: RegExp): IterableIterator<string, any, any>;
          setItem(key: string, value: any): void;
          stores<T>(regex?: RegExp): IterableIterator<Writable<T>, any, any>;
          swapItemBoolean(key: string, defaultValue?: boolean): boolean;
      }
      -
      - -
      - Implemented by -
      -       -
      -
      -
      -

      Methods

      entries -getItem -getStore -hasStore -keys -setItem -stores -swapItemBoolean -

      Methods

      entries

      • entries<T>(regex?): IterableIterator<[string, Writable<T>], any, any>

      • Type Parameters

        • T

          Returns an iterable for the session storage keys and stores.

          -

        Parameters

        • Optionalregex: RegExp

          Optional regular expression to filter by storage keys.

          -

        Returns IterableIterator<[string, Writable<T>], any, any>

        Iterable iterator of keys and stores.

        -

        Yields

      getItem

      • getItem(key, defaultValue?): unknown

      • Get value from the storage API.

        -

        Parameters

        • key: string

          Key to lookup in storage API.

          -
        • OptionaldefaultValue: any

          A default value to return if key not present in session storage.

          -

        Returns unknown

        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.

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

        -

      hasStore

      • hasStore(key): boolean

      • Returns whether a store has already been created for the given key.

        -

        Parameters

        • key: string

          Key to lookup in storage API.

          -

        Returns boolean

      keys

      • keys(regex?): IterableIterator<string, any, any>

      • Returns an iterable for the session storage keys from existing stores.

        -

        Parameters

        • Optionalregex: RegExp

          Optional regular expression to filter by storage keys.

          -

        Returns IterableIterator<string, any, any>

        Iterable iterator of session storage keys.

        -

        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<T>(regex?): IterableIterator<Writable<T>, any, any>

      • Type Parameters

        • T

          Returns an iterable for the session storage stores.

          -

        Parameters

        • Optionalregex: RegExp

          Optional regular expression to filter by storage keys.

          -

        Returns IterableIterator<Writable<T>, any, any>

        Iterable iterator of stores.

        -

        Yields

      swapItemBoolean

      • swapItemBoolean(key, defaultValue?): boolean

      • Convenience method to swap a boolean value stored in storage API updating the associated store value.

        -

        Parameters

        • key: string

          Key to lookup in storage API.

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

      On This Page

      Methods
      \ 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 d5a1046..7d6c8a9 100644 --- a/docs/interfaces/_runtime_util_animate.BasicAnimation.html +++ b/docs/interfaces/_runtime_util_animate.BasicAnimation.html @@ -1,11 +1,11 @@ -BasicAnimation | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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

      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 +

      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_dom_input_tinykeys.KeyBindingHandlerOptions.html b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingHandlerOptions.html index 478a8b3..1306798 100644 --- a/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingHandlerOptions.html +++ b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingHandlerOptions.html @@ -1,5 +1,5 @@ -KeyBindingHandlerOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface KeyBindingHandlerOptions

      interface KeyBindingHandlerOptions {
          timeout?: number;
      }
      +KeyBindingHandlerOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface KeyBindingHandlerOptions

      interface KeyBindingHandlerOptions {
          timeout?: number;
      }
      @@ -7,11 +7,11 @@
      Hierarchy
      -
      +

      Properties

      timeout?

      Properties

      Optionaltimeout

      timeout?: number

      Keybinding sequences will wait this long between key presses before cancelling (default: 1000).

      Note: Setting this value too low (i.e. 300) will be too fast for many of your users.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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_util_dom_input_tinykeys.KeyBindingMap.html b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingMap.html index 455a9ba..d7d308c 100644 --- a/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingMap.html +++ b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingMap.html @@ -1,3 +1,3 @@ -KeyBindingMap | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface KeyBindingMap

      A map of keybinding strings to event handlers.

      -

      Indexable

      Settings

      Member Visibility
      \ No newline at end of file +KeyBindingMap | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface KeyBindingMap

      A map of keybinding strings to event handlers.

      +

      Indexable

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingOptions.html b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingOptions.html index 2057c12..c08d592 100644 --- a/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingOptions.html +++ b/docs/interfaces/_runtime_util_dom_input_tinykeys.KeyBindingOptions.html @@ -1,6 +1,6 @@ -KeyBindingOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface KeyBindingOptions

      Options to configure the behavior of keybindings.

      -
      interface KeyBindingOptions {
          capture?: boolean;
          event?: "keydown" | "keyup";
          timeout?: number;
      }
      +KeyBindingOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface KeyBindingOptions

      Options to configure the behavior of keybindings.

      +
      interface KeyBindingOptions {
          capture?: boolean;
          event?: "keydown" | "keyup";
          timeout?: number;
      }
      @@ -8,15 +8,15 @@
      Hierarchy
      -
      +

      Properties

      capture? event? timeout?

      Properties

      Optionalcapture

      capture?: boolean

      Key presses will use a capture listener (default: false)

      -

      Optionalevent

      event?: "keydown" | "keyup"

      Key presses will listen to this event (default: "keydown").

      +

      Optionalevent

      event?: "keydown" | "keyup"

      Key presses will listen to this event (default: "keydown").

      Optionaltimeout

      timeout?: number

      Keybinding sequences will wait this long between key presses before cancelling (default: 1000).

      Note: Setting this value too low (i.e. 300) will be too fast for many of your users.

      -

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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_util_html_striptags.StateMachineOptions.html b/docs/interfaces/_runtime_util_html_striptags.StateMachineOptions.html index 0f40f86..09f85c6 100644 --- a/docs/interfaces/_runtime_util_html_striptags.StateMachineOptions.html +++ b/docs/interfaces/_runtime_util_html_striptags.StateMachineOptions.html @@ -1,6 +1,6 @@ -StateMachineOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface StateMachineOptions

      interface StateMachineOptions {
          allowedTags?: Set<string>;
          disallowedTags?: Set<string>;
          encodePlaintextTagDelimiters: boolean;
          tagReplacementText: string;
      }

      Properties

      allowedTags? -disallowedTags? -encodePlaintextTagDelimiters -tagReplacementText -

      Properties

      Optional ReadonlyallowedTags

      allowedTags?: Set<string>

      Optional ReadonlydisallowedTags

      disallowedTags?: Set<string>

      ReadonlyencodePlaintextTagDelimiters

      encodePlaintextTagDelimiters: boolean

      ReadonlytagReplacementText

      tagReplacementText: string

      Settings

      Member Visibility

      On This Page

      Properties
      \ No newline at end of file +StateMachineOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface StateMachineOptions

      interface StateMachineOptions {
          allowedTags?: Set<string>;
          disallowedTags?: Set<string>;
          encodePlaintextTagDelimiters: boolean;
          tagReplacementText: string;
      }

      Properties

      allowedTags? +disallowedTags? +encodePlaintextTagDelimiters +tagReplacementText +

      Properties

      Optional ReadonlyallowedTags

      allowedTags?: Set<string>

      Optional ReadonlydisallowedTags

      disallowedTags?: Set<string>

      ReadonlyencodePlaintextTagDelimiters

      encodePlaintextTagDelimiters: boolean

      ReadonlytagReplacementText

      tagReplacementText: string

      Settings

      Member Visibility

      On This Page

      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 788e7cf..903d18d 100644 --- a/docs/interfaces/_runtime_util_object.JSONArray.html +++ b/docs/interfaces/_runtime_util_object.JSONArray.html @@ -1,5 +1,5 @@ -JSONArray | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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](): ArrayIterator<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(): ArrayIterator<[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(): ArrayIterator<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;
          toLocaleString(locales: string | string[], options?: NumberFormatOptions & DateTimeFormatOptions): string;
          toString(): string;
          unshift(...items: JSONValue[]): number;
          values(): ArrayIterator<JSONValue>;
      }
      +JSONArray | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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;
              [key: number]: boolean;
          };
          length: number;
          "[iterator]"(): ArrayIterator<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(): ArrayIterator<[number, JSONValue]>;
          every<S extends JSONValue>(
              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 extends JSONValue>(
              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 extends JSONValue>(
              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 extends number = 1>(this: A, depth?: D): FlatArray<A, D>[];
          flatMap<U, This = undefined>(
              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(): ArrayIterator<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;
          toLocaleString(
              locales: string | string[],
              options?: NumberFormatOptions & DateTimeFormatOptions,
          ): string;
          toString(): string;
          unshift(...items: JSONValue[]): number;
          values(): ArrayIterator<JSONValue>;
          [n: number]: JSONValue;
      }
      @@ -7,183 +7,183 @@
      Hierarchy
      -
      +
      -

      Methods

      [iterator] -at -concat -copyWithin -entries -every -fill -filter -find -findIndex -flat -flatMap -forEach -includes -indexOf -join -keys -lastIndexOf -map -pop -push -reduce -reduceRight -reverse -shift -slice -some -sort -splice -toLocaleString -toString -unshift -values -

      Properties

      [unscopables] -length -

      Methods

      [iterator]

      at

      • at(index): JSONValue

      • Returns the item located at the specified index.

        +

      Indexable

      Methods

      [iterator] +at +concat +copyWithin +entries +every +fill +filter +find +findIndex +flat +flatMap +forEach +includes +indexOf +join +keys +lastIndexOf +map +pop +push +reduce +reduceRight +reverse +shift +slice +some +sort +splice +toLocaleString +toString +unshift +values +

      Properties

      [unscopables] +length +

      Methods

      [iterator]

      at

      • at(index: number): 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. +

      Returns JSONValue

      concat

      • concat(...items: ConcatArray<JSONValue>[]): 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.

          -

        Returns JSONValue[]

      • concat(...items): JSONValue[]

      • Combines two or more arrays. +

        Parameters

        Returns JSONValue[]

      • concat(...items: (JSONValue | ConcatArray<JSONValue>)[]): JSONValue[]

      • Combines two or more arrays. This method returns a new array without modifying any existing arrays.

        -

        Parameters

        Returns JSONValue[]

      copyWithin

      • copyWithin(target, start, end?): this

      • Returns the this object after copying a section of the array identified by start and end +

        Parameters

        Returns JSONValue[]

      copyWithin

      • copyWithin(target: number, start: number, end?: number): 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.

        • 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: JSONValue, index: number, array: JSONValue[]) => value is S)

          A function that accepts up to three arguments. The every method calls +

        Returns this

      entries

      every

      • every<S extends JSONValue>(
            predicate: (
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => value is S,
            thisArg?: any,
        ): this is S[]

      • Determines whether all the members of an array satisfy the specified test.

        +

        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

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. +

        • 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: JSONValue, index: number, array: JSONValue[]) => unknown)

          A function that accepts up to three arguments. The every method calls +

        Returns this is S[]

      • every(
            predicate: (
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => unknown,
            thisArg?: any,
        ): boolean

      • Determines whether all the members of an array satisfy the specified test.

        +

        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

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. +

        • 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

        +

      Returns boolean

      fill

      • fill(value: JSONValue, start?: number, end?: number): 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

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

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

      Returns this

      filter

      • filter<S extends JSONValue>(
            predicate: (
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => value is S,
            thisArg?: any,
        ): S[]

      • Returns the elements of an array that meet the condition specified in a callback function.

        +

        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.

          +
        • 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: (
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => unknown,
            thisArg?: any,
        ): JSONValue[]

      • Returns the elements of an array that meet the condition specified in a callback function.

        +

        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.

          +
        • 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 extends JSONValue>(
            predicate: (
                value: JSONValue,
                index: number,
                obj: JSONValue[],
            ) => value is S,
            thisArg?: any,
        ): S

      • Returns the value of the first element in the array where predicate is true, and undefined otherwise.

        -

        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 +

          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

          • OptionalthisArg: any

            If provided, it will be used as the this value for each invocation of +

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

      Returns S

    • find(
          predicate: (
              value: JSONValue,
              index: number,
              obj: JSONValue[],
          ) => unknown,
          thisArg?: any,
      ): JSONValue

    • Parameters

      • predicate: (value: JSONValue, index: number, obj: JSONValue[]) => unknown
      • OptionalthisArg: any

      Returns JSONValue

      • findIndex

      • findIndex(
            predicate: (
                value: JSONValue,
                index: number,
                obj: JSONValue[],
            ) => unknown,
            thisArg?: any,
        ): number

      • Returns the index of the first element in the array where predicate is true, and -1 otherwise.

        -

        Parameters

        • predicate: ((value: JSONValue, index: number, obj: JSONValue[]) => 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

          • OptionalthisArg: any

            If provided, it will be used as the this value for each invocation of +

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

      Returns number

      flat

      • flat<A, D extends number = 1>(this: A, depth?: D): 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
        • 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 +

        Type Parameters

        • A
        • D extends number = 1

        Parameters

        • this: A
        • Optionaldepth: D

          The maximum recursion depth

          +

        Returns FlatArray<A, D>[]

      flatMap

      • flatMap<U, This = undefined>(
            callback: (
                this: This,
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => U | readonly U[],
            thisArg?: This,
        ): 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: This, value: JSONValue, index: number, array: JSONValue[]) => 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[]

          • OptionalthisArg: This

            An object to which the this keyword can refer in the callback function. If +

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

        +

      Returns U[]

      forEach

      • forEach(
            callbackfn: (
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => void,
            thisArg?: any,
        ): void

      • Performs the specified action for each element in an array.

        +

        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.

          +
        • 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: JSONValue, fromIndex?: number): boolean

      • Determines whether an array includes a certain element, returning true or false as appropriate.

        Parameters

        • searchElement: JSONValue

          The element to search for.

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

        +

      Returns boolean

      indexOf

      • indexOf(searchElement: JSONValue, fromIndex?: number): 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.

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

        +

      Returns number

      join

      • join(separator?: string): string

      • Adds all the elements of an array into a string, separated by the specified separator string.

        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.

        +

      Returns string

      keys

      lastIndexOf

      • lastIndexOf(searchElement: JSONValue, fromIndex?: number): 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.

        • 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: 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. +

      Returns number

      map

      • map<U>(
            callbackfn: (value: JSONValue, index: number, array: JSONValue[]) => U,
            thisArg?: any,
        ): 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: 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.

          -

        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: 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: 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. +

        Returns JSONValue

      push

      • push(...items: JSONValue[]): number

      • Appends new elements to the end of an array, and returns the new length of the array.

        +

        Parameters

        • ...items: JSONValue[]

          New elements to add to the array.

          +

        Returns number

      reduce

      • reduce(
            callbackfn: (
                previousValue: JSONValue,
                currentValue: JSONValue,
                currentIndex: number,
                array: JSONValue[],
            ) => JSONValue,
        ): 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: 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: (
                previousValue: JSONValue,
                currentValue: JSONValue,
                currentIndex: number,
                array: JSONValue[],
            ) => JSONValue,
            initialValue: JSONValue,
        ): JSONValue

      • Parameters

        Returns JSONValue

      • reduce<U>(
            callbackfn: (
                previousValue: U,
                currentValue: JSONValue,
                currentIndex: number,
                array: JSONValue[],
            ) => U,
            initialValue: U,
        ): 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.

          +
        • 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: (
                previousValue: JSONValue,
                currentValue: JSONValue,
                currentIndex: number,
                array: JSONValue[],
            ) => JSONValue,
        ): 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: 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: (
                previousValue: JSONValue,
                currentValue: JSONValue,
                currentIndex: number,
                array: JSONValue[],
            ) => JSONValue,
            initialValue: JSONValue,
        ): JSONValue

      • Parameters

        Returns JSONValue

      • reduceRight<U>(
            callbackfn: (
                previousValue: U,
                currentValue: JSONValue,
                currentIndex: number,
                array: JSONValue[],
            ) => U,
            initialValue: U,
        ): 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.

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

        -

        Returns JSONValue[]

      shift

      • shift(): JSONValue

      • Removes the first element from an array and returns it. +

        Returns JSONValue[]

      shift

      • shift(): JSONValue

      • Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified.

        -

        Returns JSONValue

      slice

      • slice(start?, end?): JSONValue[]

      • Returns a copy of a section of an array. +

        Returns JSONValue

      slice

      • slice(start?: number, end?: number): 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

        • Optionalstart: number

          The beginning index of the specified portion of the array. If start is undefined, then the slice begins at index 0.

        • 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: JSONValue, index: number, array: JSONValue[]) => unknown)

          A function that accepts up to three arguments. The some method calls +

        Returns JSONValue[]

      some

      • some(
            predicate: (
                value: JSONValue,
                index: number,
                array: JSONValue[],
            ) => unknown,
            thisArg?: any,
        ): boolean

      • Determines whether the specified callback function returns true for any element of an array.

        +

        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

        • OptionalthisArg: any

          An object to which the this keyword can refer in the predicate function. +

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

      Returns boolean

      sort

      • sort(compareFn?: (a: JSONValue, b: JSONValue) => number): this

      • Sorts an array in place. This method mutates the array and returns a reference to the same array.

        -

        Parameters

        • OptionalcompareFn: ((a: JSONValue, b: JSONValue) => 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)
            -

          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.

        +

      Returns this

      splice

      • splice(start: number, deleteCount?: number): 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.

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

        +
      • splice(start: number, deleteCount: number, ...items: JSONValue[]): 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.

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

      • toLocaleString(locales, options?): string

      • Parameters

        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.

          -

        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' +

      toLocaleString

      • toLocaleString(): string

      • Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

        +

        Returns string

      • toLocaleString(
            locales: string | string[],
            options?: NumberFormatOptions & DateTimeFormatOptions,
        ): string

      • Parameters

        Returns string

      toString

      • toString(): string

      • Returns a string representation of an array.

        +

        Returns string

      unshift

      • unshift(...items: JSONValue[]): number

      • Inserts new elements at the start of an array, and returns the new length of the array.

        +

        Parameters

        • ...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;
          [key: number]: boolean;
      }

      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

        • [key: number]: boolean
        • Optional Readonly[unscopables]?: boolean

          Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

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

      On This Page

      Methods
      Properties
      \ No newline at end of file +
    • 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

      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 2bf205e..be9f3d5 100644 --- a/docs/interfaces/_runtime_util_object.JSONObject.html +++ b/docs/interfaces/_runtime_util_object.JSONObject.html @@ -1,2 +1,2 @@ -JSONObject | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface JSONObject

      Indexable

      Settings

      Member Visibility
      \ No newline at end of file +JSONObject | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface JSONObject

      Indexable

      Settings

      Member Visibility
      \ No newline at end of file diff --git a/docs/interfaces/_standard_store_fvtt_settings.UIControl.html b/docs/interfaces/_standard_store_fvtt_settings.UIControl.html index 9582dff..453b3d5 100644 --- a/docs/interfaces/_standard_store_fvtt_settings.UIControl.html +++ b/docs/interfaces/_standard_store_fvtt_settings.UIControl.html @@ -1,21 +1,21 @@ -UIControl | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface UIControl

      Controls preparation and processing of registered game settings w/ TJSGameSettings. Game settings are parsed +UIControl | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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: TJSSettingsCustomSection): void;
          create(options?: TJSSettingsCreateOptions): TJSSettingsUIData;
          swapShowSettings(): boolean;
      }

      Accessors

      showSettings +
      interface UIControl {
          get showSettings(): boolean;
          set showSettings(showSettings: boolean): void;
          get stores(): { showSettings: Readable<boolean> };
          addSection(options: TJSSettingsCustomSection): void;
          create(options?: TJSSettingsCreateOptions): TJSSettingsUIData;
          swapShowSettings(): boolean;
      }

      Accessors

      showSettings stores -

      Methods

      addSection +

      Methods

      addSection create -swapShowSettings -

      Accessors

      showSettings

      • get showSettings(): boolean

      • Returns boolean

        Current showSettings state.

        -
      • set showSettings(showSettings): void

      • Sets current showSettings state.

        +swapShowSettings +

      Accessors

      showSettings

      • get showSettings(): boolean

      • Returns boolean

        Current showSettings state.

        +
      • set showSettings(showSettings: boolean): 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.

        +

      Returns void

      stores

      • get stores(): { showSettings: Readable<boolean> }

      • Returns { showSettings: Readable<boolean> }

        Returns the managed stores.

        +

      Methods

      addSection

      • addSection(options: TJSSettingsCustomSection): void

      • Adds a custom section / folder defined by the provided TJSSettingsCustomSection options object.

        Parameters

        Returns void

      create

      • create(options?): TJSSettingsUIData

      • Creates the UISettingsData object by parsing stored settings in

        +

      Returns void

      create

      swapShowSettings

      • swapShowSettings(): boolean

      • Convenience method to swap showSettings.

        +

      swapShowSettings

      • swapShowSettings(): boolean

      • Convenience method to swap showSettings.

        Returns boolean

        New showSettings state.

        -

      Settings

      Member Visibility

      On This Page

      Accessors
      Methods
      \ 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/svelte.ComponentConstructorOptions.html b/docs/interfaces/svelte.ComponentConstructorOptions.html index ac3e383..ff26d00 100644 --- a/docs/interfaces/svelte.ComponentConstructorOptions.html +++ b/docs/interfaces/svelte.ComponentConstructorOptions.html @@ -1,9 +1,9 @@ -ComponentConstructorOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface ComponentConstructorOptions<Props>

      interface ComponentConstructorOptions<Props> {
          $$inline?: boolean;
          anchor?: Element;
          context?: Map<any, any>;
          hydrate?: boolean;
          intro?: boolean;
          props?: Props;
          target: ShadowRoot | Element | Document;
      }

      Type Parameters

      Properties

      $$inline? +ComponentConstructorOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ComponentConstructorOptions<Props>

      interface ComponentConstructorOptions<
          Props extends Record<string, any> = Record<string, any>,
      > {
          $$inline?: boolean;
          anchor?: Element;
          context?: Map<any, any>;
          hydrate?: boolean;
          intro?: boolean;
          props?: Props;
          target: ShadowRoot | Element | Document;
      }

      Type Parameters

      Properties

      $$inline? anchor? context? hydrate? intro? props? target -

      Properties

      Optional$$inline

      $$inline?: boolean

      Optionalanchor

      anchor?: Element

      Optionalcontext

      context?: Map<any, any>

      Optionalhydrate

      hydrate?: boolean

      Optionalintro

      intro?: boolean

      Optionalprops

      props?: Props

      target

      target: ShadowRoot | Element | Document

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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: ShadowRoot | Element | Document

      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 7b324da..d0cfa66 100644 --- a/docs/interfaces/svelte.DispatchOptions.html +++ b/docs/interfaces/svelte.DispatchOptions.html @@ -1,3 +1,3 @@ -DispatchOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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 +DispatchOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 28291dd..46b061e 100644 --- a/docs/interfaces/svelte.EventDispatcher.html +++ b/docs/interfaces/svelte.EventDispatcher.html @@ -1,2 +1,2 @@ -EventDispatcher | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface EventDispatcher<EventMap>

      Type Parameters

      • EventMap extends Record<string, any>

      Settings

      Member Visibility
      \ No newline at end of file +EventDispatcher | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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 fe3e29f..0906f59 100644 --- a/docs/interfaces/svelte_action.Action.html +++ b/docs/interfaces/svelte_action.Action.html @@ -1,5 +1,5 @@ -Action | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Action<Element, Parameter, Attributes>

      Actions are functions that are called when an element is created. +Action | TyphonJS Runtime Library (FVTT) 0.2.0

      +

      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:

      @@ -10,4 +10,4 @@

      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

      -

      Type Parameters

      Settings

      Member Visibility
      \ No newline at end of file +

      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 4b4770e..2eed7ab 100644 --- a/docs/interfaces/svelte_action.ActionReturn.html +++ b/docs/interfaces/svelte_action.ActionReturn.html @@ -1,5 +1,5 @@ -ActionReturn | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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 @@ -13,9 +13,9 @@

        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? +
      interface ActionReturn<
          Parameter = undefined,
          Attributes extends Record<string, any> = Record<never, any>,
      > {
          $$_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.

      -

      Optionaldestroy

      destroy?: (() => void)

      Optionalupdate

      update?: ((parameter: Parameter) => void)

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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 604c566..f778fc0 100644 --- a/docs/interfaces/svelte_animate.AnimationConfig.html +++ b/docs/interfaces/svelte_animate.AnimationConfig.html @@ -1,7 +1,7 @@ -AnimationConfig | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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? +AnimationConfig | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      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 +

      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 8b428e1..4da4bc4 100644 --- a/docs/interfaces/svelte_animate.FlipParams.html +++ b/docs/interfaces/svelte_animate.FlipParams.html @@ -1,5 +1,5 @@ -FlipParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface FlipParams

      interface FlipParams {
          delay?: number;
          duration?: number | ((len: number) => number);
          easing?: ((t: number) => number);
      }

      Properties

      delay? +FlipParams | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface FlipParams

      interface FlipParams {
          delay?: number;
          duration?: number | (len: number) => number;
          easing?: (t: number) => number;
      }

      Properties

      delay? duration? easing? -

      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 +

      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 036d891..7e9f0d1 100644 --- a/docs/interfaces/svelte_motion.Readable.html +++ b/docs/interfaces/svelte_motion.Readable.html @@ -1,6 +1,6 @@ -Readable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Readable<T>

      Readable interface for subscribing.

      -
      interface Readable<T> {
          subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
      }

      Type Parameters

      • T
      +Readable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Readable<T>

      Readable interface for subscribing.

      +
      interface Readable<T> {
          subscribe(
              this: void,
              run: Subscriber<T>,
              invalidate?: Invalidator<T>,
          ): Unsubscriber;
      }

      Type Parameters

      • T
      @@ -8,10 +8,10 @@
      Hierarchy
      -
      +

      Methods

      subscribe -

      Methods

      subscribe

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file +

      Methods

      subscribe

      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 b030740..76a93d4 100644 --- a/docs/interfaces/svelte_motion.Spring-1.html +++ b/docs/interfaces/svelte_motion.Spring-1.html @@ -1,6 +1,6 @@ -Spring | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +Spring | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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
      @@ -8,7 +8,7 @@
      Hierarchy
      -
      +

      Methods

      subscribe

      Properties

      damping @@ -16,7 +16,7 @@
      set stiffness update -

      Methods

      subscribe

      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 +

      Methods

      subscribe

      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 d908e2d..d5354e0 100644 --- a/docs/interfaces/svelte_motion.SpringOpts.html +++ b/docs/interfaces/svelte_motion.SpringOpts.html @@ -1,5 +1,5 @@ -SpringOpts | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface SpringOpts

      interface SpringOpts {
          damping?: number;
          precision?: number;
          stiffness?: number;
      }

      Properties

      damping? +SpringOpts | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface SpringOpts

      interface SpringOpts {
          damping?: number;
          precision?: number;
          stiffness?: number;
      }

      Properties

      damping? precision? stiffness? -

      Properties

      Optionaldamping

      damping?: number

      Optionalprecision

      precision?: number

      Optionalstiffness

      stiffness?: number

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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 48cee24..2cbbb08 100644 --- a/docs/interfaces/svelte_motion.SpringUpdateOpts.html +++ b/docs/interfaces/svelte_motion.SpringUpdateOpts.html @@ -1,4 +1,4 @@ -SpringUpdateOpts | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface SpringUpdateOpts

      interface SpringUpdateOpts {
          hard?: any;
          soft?: string | number | boolean;
      }

      Properties

      hard? +SpringUpdateOpts | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface SpringUpdateOpts

      interface SpringUpdateOpts {
          hard?: any;
          soft?: string | number | boolean;
      }

      Properties

      hard? soft? -

      Properties

      Optionalhard

      hard?: any

      Optionalsoft

      soft?: string | number | boolean

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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 c008c82..fa8d0f4 100644 --- a/docs/interfaces/svelte_motion.Tweened-1.html +++ b/docs/interfaces/svelte_motion.Tweened-1.html @@ -1,6 +1,6 @@ -Tweened | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +Tweened | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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
      @@ -8,12 +8,12 @@
      Hierarchy
      -
      +

      Methods

      set subscribe update -

      Methods

      set

      subscribe

      update

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file +

      Methods

      set

      subscribe

      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 4559a90..06debc2 100644 --- a/docs/interfaces/svelte_motion.TweenedOptions.html +++ b/docs/interfaces/svelte_motion.TweenedOptions.html @@ -1,6 +1,6 @@ -TweenedOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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? +TweenedOptions | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      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 +

      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 4c6bf85..a8eb34b 100644 --- a/docs/interfaces/svelte_store.Readable-1.html +++ b/docs/interfaces/svelte_store.Readable-1.html @@ -1,6 +1,6 @@ -Readable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface Readable<T>

      Readable interface for subscribing.

      -
      interface Readable<T> {
          subscribe(this: void, run: Subscriber<T>, invalidate?: Invalidator<T>): Unsubscriber;
      }

      Type Parameters

      • T
      +Readable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface Readable<T>

      Readable interface for subscribing.

      +
      interface Readable<T> {
          subscribe(
              this: void,
              run: Subscriber<T>,
              invalidate?: Invalidator<T>,
          ): Unsubscriber;
      }

      Type Parameters

      • T
      @@ -8,10 +8,10 @@
      Hierarchy
      -
      +

      Methods

      subscribe -

      Methods

      subscribe

      Settings

      Member Visibility

      On This Page

      Methods
      \ No newline at end of file +

      Methods

      subscribe

      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 f8a3629..47da790 100644 --- a/docs/interfaces/svelte_store.Writable-1.html +++ b/docs/interfaces/svelte_store.Writable-1.html @@ -1,6 +1,6 @@ -Writable | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +Writable | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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
      @@ -8,16 +8,16 @@
      Hierarchy
      -
      +

      Methods

      set subscribe update -

      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

      On This Page

      Methods
      \ No newline at end of file +

      Methods

      set

      • set(this: void, value: T): void

      • Set value and inform subscribers.

        +

        Parameters

        • this: void
        • value: T

          to set

          +

        Returns void

      subscribe

      update

      • update(this: void, updater: Updater<T>): void

      • Update value using callback and inform subscribers.

        +

        Parameters

        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 6c5c761..6f19770 100644 --- a/docs/interfaces/svelte_transition.BlurParams.html +++ b/docs/interfaces/svelte_transition.BlurParams.html @@ -1,7 +1,7 @@ -BlurParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      Interface BlurParams

      interface BlurParams {
          amount?: string | number;
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
          opacity?: number;
      }

      Properties

      amount? delay? duration? easing? opacity? -

      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 +

      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 050e524..20d8d70 100644 --- a/docs/interfaces/svelte_transition.CrossfadeParams.html +++ b/docs/interfaces/svelte_transition.CrossfadeParams.html @@ -1,5 +1,5 @@ -CrossfadeParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface CrossfadeParams

      interface CrossfadeParams {
          delay?: number;
          duration?: number | ((len: number) => number);
          easing?: EasingFunction;
      }

      Properties

      delay? +CrossfadeParams | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface CrossfadeParams

      interface CrossfadeParams {
          delay?: number;
          duration?: number | (len: number) => number;
          easing?: EasingFunction;
      }

      Properties

      delay? duration? easing? -

      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 +

      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 2b955fd..e055c8b 100644 --- a/docs/interfaces/svelte_transition.DrawParams.html +++ b/docs/interfaces/svelte_transition.DrawParams.html @@ -1,6 +1,6 @@ -DrawParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface DrawParams

      interface DrawParams {
          delay?: number;
          duration?: number | ((len: number) => number);
          easing?: EasingFunction;
          speed?: number;
      }

      Properties

      delay? +DrawParams | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface DrawParams

      interface DrawParams {
          delay?: number;
          duration?: number | (len: number) => number;
          easing?: EasingFunction;
          speed?: number;
      }

      Properties

      delay? duration? easing? speed? -

      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 +

      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 3dcc437..a1df5da 100644 --- a/docs/interfaces/svelte_transition.FadeParams.html +++ b/docs/interfaces/svelte_transition.FadeParams.html @@ -1,5 +1,5 @@ -FadeParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface FadeParams

      interface FadeParams {
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
      }

      Properties

      delay? +FadeParams | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface FadeParams

      interface FadeParams {
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
      }

      Properties

      delay? duration? easing? -

      Properties

      Optionaldelay

      delay?: number

      Optionalduration

      duration?: number

      Optionaleasing

      easing?: EasingFunction

      Settings

      Member Visibility

      On This Page

      Properties
      \ 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 687a283..e1b2b21 100644 --- a/docs/interfaces/svelte_transition.FlyParams.html +++ b/docs/interfaces/svelte_transition.FlyParams.html @@ -1,8 +1,8 @@ -FlyParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      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
      +

      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

      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 +

      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 e5fab06..d86f2e9 100644 --- a/docs/interfaces/svelte_transition.ScaleParams.html +++ b/docs/interfaces/svelte_transition.ScaleParams.html @@ -1,7 +1,7 @@ -ScaleParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface ScaleParams

      interface ScaleParams {
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
          opacity?: number;
          start?: number;
      }

      Properties

      delay? +ScaleParams | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface ScaleParams

      interface ScaleParams {
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
          opacity?: number;
          start?: number;
      }

      Properties

      delay? duration? easing? opacity? start? -

      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 +

      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 98db7ae..f6c15e5 100644 --- a/docs/interfaces/svelte_transition.SlideParams.html +++ b/docs/interfaces/svelte_transition.SlideParams.html @@ -1,6 +1,6 @@ -SlideParams | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface SlideParams

      interface SlideParams {
          axis?: "x" | "y";
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
      }

      Properties

      axis? +SlideParams | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      Interface SlideParams

      interface SlideParams {
          axis?: "x" | "y";
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
      }

      Properties

      axis? delay? duration? easing? -

      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 +

      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 51bc20f..5c05ad8 100644 --- a/docs/interfaces/svelte_transition.TransitionConfig.html +++ b/docs/interfaces/svelte_transition.TransitionConfig.html @@ -1,7 +1,7 @@ -TransitionConfig | TyphonJS Runtime Library (FVTT) 0.2.0
      -

      Interface TransitionConfig

      interface TransitionConfig {
          css?: ((t: number, u: number) => string);
          delay?: number;
          duration?: number;
          easing?: EasingFunction;
          tick?: ((t: number, u: number) => void);
      }

      Properties

      css? +TransitionConfig | TyphonJS Runtime Library (FVTT) 0.2.0
      +

      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

      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 +

      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.html b/docs/modules.html index a9d9f95..8bf04fc 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,96 +1,2 @@ -TyphonJS Runtime Library (FVTT) 0.2.0
      -

        TyphonJS Runtime Library (FVTT) 0.2.0

        - -

        - Index -

        -         -
        -

        Packages

        #runtime/data/color/colord -#runtime/data/compress -#runtime/data/format/base64 -#runtime/data/format/json5 -#runtime/data/format/jsonc -#runtime/data/format/msgpack -#runtime/data/format/msgpack/compress -#runtime/data/format/unicode -#runtime/data/struct/cache/quick-lru -#runtime/data/struct/hash/array -#runtime/data/struct/search/trie -#runtime/data/struct/search/trie/query -#runtime/math/gl-matrix -#runtime/math/interpolate -#runtime/math/physics -#runtime/math/util -#runtime/plugin/manager -#runtime/plugin/manager/eventbus -#runtime/svelte/action/dom/focus -#runtime/svelte/action/dom/input -#runtime/svelte/action/dom/observer -#runtime/svelte/action/dom/properties -#runtime/svelte/action/dom/style -#runtime/svelte/action/util -#runtime/svelte/animate -#runtime/svelte/animate/gsap -#runtime/svelte/animate/gsap/plugin -#runtime/svelte/animate/gsap/plugin/bonus -#runtime/svelte/application -#runtime/svelte/component/application -#runtime/svelte/easing -#runtime/svelte/store/dom/input -#runtime/svelte/store/fvtt/document -#runtime/svelte/store/fvtt/settings -#runtime/svelte/store/fvtt/settings/world -#runtime/svelte/store/position -#runtime/svelte/store/reducer -#runtime/svelte/store/reducer/array-object -#runtime/svelte/store/util -#runtime/svelte/store/web-storage -#runtime/svelte/store/web-storage/msgpack -#runtime/svelte/store/writable-derived -#runtime/svelte/transition -#runtime/svelte/util -#runtime/util -#runtime/util/a11y -#runtime/util/animate -#runtime/util/async -#runtime/util/browser -#runtime/util/dom/input/tinykeys -#runtime/util/dom/layout -#runtime/util/dom/observer -#runtime/util/dom/style -#runtime/util/html -#runtime/util/html/striptags -#runtime/util/i18n -#runtime/util/loader-module -#runtime/util/object -#standard/action/animate/composable -#standard/application/control/filepicker -#standard/application/control/sidebar -#standard/application/dialog/document -#standard/application/menu -#standard/component/button -#standard/component/color/picker-colord -#standard/component/container -#standard/component/dom/focus -#standard/component/folder -#standard/component/form -#standard/component/fvtt/editor -#standard/component/fvtt/filepicker/button -#standard/component/fvtt/settings -#standard/component/label -#standard/component/layer/position -#standard/component/layer/side-slide -#standard/component/media -#standard/component/menu -#standard/fvtt -#standard/store/fvtt/settings -svelte -svelte/action -svelte/animate -svelte/easing -svelte/motion -svelte/store -svelte/transition -
        -

        Settings

        Member Visibility
        \ No newline at end of file +TyphonJS Runtime Library (FVTT) 0.2.0
        +

          TyphonJS Runtime Library (FVTT) 0.2.0

          Packages

          #runtime/data/color/colord
          #runtime/data/compress
          #runtime/data/format/base64
          #runtime/data/format/json5
          #runtime/data/format/jsonc
          #runtime/data/format/msgpack
          #runtime/data/format/msgpack/compress
          #runtime/data/format/unicode
          #runtime/data/struct/cache/quick-lru
          #runtime/data/struct/hash/array
          #runtime/data/struct/search/trie
          #runtime/data/struct/search/trie/query
          #runtime/math/gl-matrix
          #runtime/math/interpolate
          #runtime/math/physics
          #runtime/math/util
          #runtime/plugin/manager
          #runtime/plugin/manager/eventbus
          #runtime/svelte/action/dom/focus
          #runtime/svelte/action/dom/input
          #runtime/svelte/action/dom/observer
          #runtime/svelte/action/dom/properties
          #runtime/svelte/action/dom/style
          #runtime/svelte/action/util
          #runtime/svelte/animate
          #runtime/svelte/animate/gsap
          #runtime/svelte/animate/gsap/plugin
          #runtime/svelte/animate/gsap/plugin/bonus
          #runtime/svelte/application
          #runtime/svelte/component/application
          #runtime/svelte/easing
          #runtime/svelte/store/dom/input
          #runtime/svelte/store/fvtt/document
          #runtime/svelte/store/fvtt/settings
          #runtime/svelte/store/fvtt/settings/world
          #runtime/svelte/store/position
          #runtime/svelte/store/reducer
          #runtime/svelte/store/reducer/array-object
          #runtime/svelte/store/util
          #runtime/svelte/store/web-storage
          #runtime/svelte/store/web-storage/msgpack
          #runtime/svelte/store/writable-derived
          #runtime/svelte/transition
          #runtime/svelte/util
          #runtime/util
          #runtime/util/a11y
          #runtime/util/animate
          #runtime/util/async
          #runtime/util/browser
          #runtime/util/dom/input/tinykeys
          #runtime/util/dom/layout
          #runtime/util/dom/observer
          #runtime/util/dom/style
          #runtime/util/html
          #runtime/util/html/striptags
          #runtime/util/i18n
          #runtime/util/loader-module
          #runtime/util/object
          #standard/action/animate/composable
          #standard/application/control/filepicker
          #standard/application/control/sidebar
          #standard/application/dialog/document
          #standard/application/menu
          #standard/component/button
          #standard/component/color/picker-colord
          #standard/component/container
          #standard/component/dom/focus
          #standard/component/folder
          #standard/component/form
          #standard/component/fvtt/editor
          #standard/component/fvtt/filepicker/button
          #standard/component/fvtt/settings
          #standard/component/label
          #standard/component/layer/position
          #standard/component/layer/side-slide
          #standard/component/media
          #standard/component/menu
          #standard/fvtt
          #standard/store/fvtt/settings
          svelte
          svelte/action
          svelte/animate
          svelte/easing
          svelte/motion
          svelte/store
          svelte/transition

          Settings

          Member Visibility

          On This Page

          Packages
          #runtime/data/color/colord#runtime/data/compress#runtime/data/format/base64#runtime/data/format/json5#runtime/data/format/jsonc#runtime/data/format/msgpack#runtime/data/format/msgpack/compress#runtime/data/format/unicode#runtime/data/struct/cache/quick-lru#runtime/data/struct/hash/array#runtime/data/struct/search/trie#runtime/data/struct/search/trie/query#runtime/math/gl-matrix#runtime/math/interpolate#runtime/math/physics#runtime/math/util#runtime/plugin/manager#runtime/plugin/manager/eventbus#runtime/svelte/action/dom/focus#runtime/svelte/action/dom/input#runtime/svelte/action/dom/observer#runtime/svelte/action/dom/properties#runtime/svelte/action/dom/style#runtime/svelte/action/util#runtime/svelte/animate#runtime/svelte/animate/gsap#runtime/svelte/animate/gsap/plugin#runtime/svelte/animate/gsap/plugin/bonus#runtime/svelte/application#runtime/svelte/component/application#runtime/svelte/easing#runtime/svelte/store/dom/input#runtime/svelte/store/fvtt/document#runtime/svelte/store/fvtt/settings#runtime/svelte/store/fvtt/settings/world#runtime/svelte/store/position#runtime/svelte/store/reducer#runtime/svelte/store/reducer/array-object#runtime/svelte/store/util#runtime/svelte/store/web-storage#runtime/svelte/store/web-storage/msgpack#runtime/svelte/store/writable-derived#runtime/svelte/transition#runtime/svelte/util#runtime/util#runtime/util/a11y#runtime/util/animate#runtime/util/async#runtime/util/browser#runtime/util/dom/input/tinykeys#runtime/util/dom/layout#runtime/util/dom/observer#runtime/util/dom/style#runtime/util/html#runtime/util/html/striptags#runtime/util/i18n#runtime/util/loader-module#runtime/util/object#standard/action/animate/composable#standard/application/control/filepicker#standard/application/control/sidebar#standard/application/dialog/document#standard/application/menu#standard/component/button#standard/component/color/picker-colord#standard/component/container#standard/component/dom/focus#standard/component/folder#standard/component/form#standard/component/fvtt/editor#standard/component/fvtt/filepicker/button#standard/component/fvtt/settings#standard/component/label#standard/component/layer/position#standard/component/layer/side-slide#standard/component/media#standard/component/menu#standard/fvtt#standard/store/fvtt/settingssveltesvelte/actionsvelte/animatesvelte/easingsvelte/motionsvelte/storesvelte/transition
          \ No newline at end of file diff --git a/docs/modules/_runtime_data_color_colord.html b/docs/modules/_runtime_data_color_colord.html index 0b32c77..c498513 100644 --- a/docs/modules/_runtime_data_color_colord.html +++ b/docs/modules/_runtime_data_color_colord.html @@ -1,34 +1,5 @@ -#runtime/data/color/colord | TyphonJS Runtime Library (FVTT) 0.2.0
          -

            Package #runtime/data/color/colord

            Documentation: https://github.com/omgovich/colord#getting-started

            +#runtime/data/color/colord | TyphonJS Runtime Library (FVTT) 0.2.0
            +

              Package #runtime/data/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 as it is not maintained.

              -
              - -

              - Index -

              -               -
              -

              Classes

              Colord -

              Functions

              colord -extend -getFormat -random -

              Interfaces

              LabColor -LchColor -XyzColor -

              Type Aliases

              AnyColor -HslaColor -HslColor -HsvaColor -HsvColor -HwbaColor -HwbColor -LabaColor -LchaColor -Plugin -RgbaColor -RgbColor -XyzaColor -
              -

              Settings

              Member Visibility
              \ No newline at end of file +

              Classes

              Colord

              Functions

              colord
              extend
              getFormat
              random

              Interfaces

              LabColor
              LchColor
              XyzColor

              Type Aliases

              AnyColor
              HslaColor
              HslColor
              HsvaColor
              HsvColor
              HwbaColor
              HwbColor
              LabaColor
              LchaColor
              Plugin
              RgbaColor
              RgbColor
              XyzaColor

              Settings

              Member Visibility

              On This Page

              Classes
              Functions
              Interfaces
              Type Aliases
              \ No newline at end of file diff --git a/docs/modules/_runtime_data_compress.html b/docs/modules/_runtime_data_compress.html index b2a958f..b533eb3 100644 --- a/docs/modules/_runtime_data_compress.html +++ b/docs/modules/_runtime_data_compress.html @@ -1,92 +1,2 @@ -#runtime/data/compress | TyphonJS Runtime Library (FVTT) 0.2.0
              -

                Package #runtime/data/compress

                Classes

                AsyncCompress -AsyncDecompress -AsyncDeflate -AsyncGunzip -AsyncInflate -AsyncUnzipInflate -AsyncUnzlib -AsyncZipDeflate -AsyncZlib -Compress -DecodeUTF8 -Decompress -Deflate -EncodeUTF8 -Gunzip -Inflate -Unzip -UnzipInflate -UnzipPassThrough -Unzlib -Zip -ZipDeflate -ZipPassThrough -Zlib -

                Functions

                compress -compressSync -decompress -decompressSync -deflate -deflateSync -gunzip -gunzipSync -inflate -inflateSync -strFromU8 -strToU8 -unzip -unzipSync -unzlib -unzlibSync -zip -zipSync -zlib -zlibSync -

                Variables

                FlateErrorCode -

                Interfaces

                AsyncDeflateOptions -AsyncGunzipOptions -AsyncGzipOptions -AsyncInflateOptions -AsyncTerminable -AsyncUnzipOptions -AsyncUnzlibOptions -AsyncZipOptions -AsyncZippable -AsyncZlibOptions -DeflateOptions -FlateError -GunzipOptions -GunzipStreamOptions -GzipOptions -InflateOptions -InflateStreamOptions -UnzipDecoder -UnzipDecoderConstructor -UnzipFile -UnzipFileInfo -UnzipOptions -Unzipped -UnzlibOptions -UnzlibStreamOptions -ZipAttributes -ZipInputFile -ZipOptions -Zippable -ZlibOptions -

                Type Aliases

                AsyncFlateDrainHandler -AsyncFlateStreamHandler -AsyncZippableFile -FlateCallback -FlateStreamHandler -GunzipMemberHandler -StringStreamHandler -UnzipCallback -UnzipFileFilter -UnzipFileHandler -ZippableFile -

                References

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

                On This Page

                References
                \ No newline at end of file +#runtime/data/compress | TyphonJS Runtime Library (FVTT) 0.2.0
                +

                  Package #runtime/data/compress

                  Classes

                  AsyncCompress
                  AsyncDecompress
                  AsyncDeflate
                  AsyncGunzip
                  AsyncInflate
                  AsyncUnzipInflate
                  AsyncUnzlib
                  AsyncZipDeflate
                  AsyncZlib
                  Compress
                  DecodeUTF8
                  Decompress
                  Deflate
                  EncodeUTF8
                  Gunzip
                  Inflate
                  Unzip
                  UnzipInflate
                  UnzipPassThrough
                  Unzlib
                  Zip
                  ZipDeflate
                  ZipPassThrough
                  Zlib

                  Functions

                  compress
                  compressSync
                  decompress
                  decompressSync
                  deflate
                  deflateSync
                  gunzip
                  gunzipSync
                  inflate
                  inflateSync
                  strFromU8
                  strToU8
                  unzip
                  unzipSync
                  unzlib
                  unzlibSync
                  zip
                  zipSync
                  zlib
                  zlibSync

                  Variables

                  FlateErrorCode

                  Interfaces

                  AsyncDeflateOptions
                  AsyncGunzipOptions
                  AsyncGzipOptions
                  AsyncInflateOptions
                  AsyncTerminable
                  AsyncUnzipOptions
                  AsyncUnzlibOptions
                  AsyncZipOptions
                  AsyncZippable
                  AsyncZlibOptions
                  DeflateOptions
                  FlateError
                  GunzipOptions
                  GunzipStreamOptions
                  GzipOptions
                  InflateOptions
                  InflateStreamOptions
                  UnzipDecoder
                  UnzipDecoderConstructor
                  UnzipFile
                  UnzipFileInfo
                  UnzipOptions
                  Unzipped
                  UnzlibOptions
                  UnzlibStreamOptions
                  ZipAttributes
                  ZipInputFile
                  ZipOptions
                  Zippable
                  ZlibOptions

                  Type Aliases

                  AsyncFlateDrainHandler
                  AsyncFlateStreamHandler
                  AsyncZippableFile
                  FlateCallback
                  FlateStreamHandler
                  GunzipMemberHandler
                  StringStreamHandler
                  UnzipCallback
                  UnzipFileFilter
                  UnzipFileHandler
                  ZippableFile

                  References

                  AsyncGzip â†’ AsyncCompress
                  gzip â†’ compress
                  Gzip â†’ Compress
                  gzipSync â†’ compressSync

                  Settings

                  Member Visibility

                  On This Page

                  Classes
                  Functions
                  Variables
                  Interfaces
                  Type Aliases
                  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 9fd0773..3f8dceb 100644 --- a/docs/modules/_runtime_data_format_base64.html +++ b/docs/modules/_runtime_data_format_base64.html @@ -1,23 +1,2 @@ -#runtime/data/format/base64 | TyphonJS Runtime Library (FVTT) 0.2.0
                  -

                    Package #runtime/data/format/base64

                    Functions

                    atob -atobPolyfill -btoa -btoaPolyfill -btou -decode -encode -encodeURI -extendBuiltins -extendString -extendUint8Array -fromUint8Array -isValid -toUint8Array -utob -

                    Variables

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

                    On This Page

                    References
                    \ No newline at end of file +#runtime/data/format/base64 | TyphonJS Runtime Library (FVTT) 0.2.0
                    +

                      Package #runtime/data/format/base64

                      Functions

                      atob
                      atobPolyfill
                      btoa
                      btoaPolyfill
                      btou
                      decode
                      encode
                      encodeURI
                      extendBuiltins
                      extendString
                      extendUint8Array
                      fromUint8Array
                      isValid
                      toUint8Array
                      utob

                      Variables

                      Base64
                      version
                      VERSION

                      References

                      encodeURL â†’ encodeURI
                      fromBase64 â†’ decode
                      toBase64 â†’ encode

                      Settings

                      Member Visibility

                      On This Page

                      Functions
                      Variables
                      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 53126f9..052eab9 100644 --- a/docs/modules/_runtime_data_format_json5.html +++ b/docs/modules/_runtime_data_format_json5.html @@ -1,12 +1,2 @@ -#runtime/data/format/json5 | TyphonJS Runtime Library (FVTT) 0.2.0
                      -

                        Package #runtime/data/format/json5

                        - -

                        - Index -

                        -                         -
                        -

                        Interfaces

                        JSON5 -

                        Type Aliases

                        StringifyOptions -
                        -

                        Settings

                        Member Visibility
                        \ No newline at end of file +#runtime/data/format/json5 | TyphonJS Runtime Library (FVTT) 0.2.0
                        +

                          Package #runtime/data/format/json5

                          Interfaces

                          JSON5

                          Type Aliases

                          StringifyOptions

                          Settings

                          Member Visibility

                          On This Page

                          Interfaces
                          Type Aliases
                          \ No newline at end of file diff --git a/docs/modules/_runtime_data_format_jsonc.html b/docs/modules/_runtime_data_format_jsonc.html index 72d88b1..7cd2da8 100644 --- a/docs/modules/_runtime_data_format_jsonc.html +++ b/docs/modules/_runtime_data_format_jsonc.html @@ -1,49 +1,10 @@ -#runtime/data/format/jsonc | TyphonJS Runtime Library (FVTT) 0.2.0
                          -

                            Package #runtime/data/format/jsonc

                            JSONC is JSON with JavaScript style comments. This provides a scanner and fault-tolerant parser that can process +#runtime/data/format/jsonc | TyphonJS Runtime Library (FVTT) 0.2.0

                            +

                              Package #runtime/data/format/jsonc

                              JSONC is JSON with JavaScript style comments. This provides a scanner and fault-tolerant parser that can process JSONC but is also useful for standard JSON.

                              In particular for just parsing like JSON.parse use the parse function. All the other functions provided involve AST manipulation:

                              - the `parse` function evaluates the JavaScript object represented by JSON string in a fault-tolerant fashion.
                              - the `scanner` tokenizes the input string into tokens and token offsets
                              - the `visit` function implements a 'SAX' style parser with callbacks for the encountered properties and values.
                              - the `parseTree` function computes a hierarchical DOM with offsets representing the encountered properties and
                              values.
                              - the `getLocation` API returns a location object that describes the property or value located at a given offset in
                              a JSON document.
                              - the `findNodeAtLocation` API finds the node at a given location path in a JSON DOM.
                              - the `format` API computes edits to format a JSON document.
                              - the `modify` API computes edits to insert, remove or replace a property or value in a JSON document.
                              - the `applyEdits` API applies edits to a document.
                              -

                              See

                              https://www.npmjs.com/package/jsonc-parser

                              -
                              - -

                              - Index -

                              -                               -
                              -

                              Functions

                              applyEdits -createScanner -findNodeAtLocation -findNodeAtOffset -format -getLocation -getNodePath -getNodeValue -modify -parse -parseTree -printParseErrorCode -stripComments -visit -

                              Enumerations

                              ParseErrorCode -ScanError -SyntaxKind -

                              Interfaces

                              Edit -FormattingOptions -JSONScanner -JSONVisitor -Location -ModificationOptions -Node -ParseError -ParseOptions -Range -

                              Type Aliases

                              EditResult -JSONPath -NodeType -Segment -
                              -

                              Settings

                              Member Visibility
                              \ No newline at end of file +

                              See

                              https://www.npmjs.com/package/jsonc-parser

                              +

                              Functions

                              applyEdits
                              createScanner
                              findNodeAtLocation
                              findNodeAtOffset
                              format
                              getLocation
                              getNodePath
                              getNodeValue
                              modify
                              parse
                              parseTree
                              printParseErrorCode
                              stripComments
                              visit

                              Enumerations

                              ParseErrorCode
                              ScanError
                              SyntaxKind

                              Interfaces

                              Edit
                              FormattingOptions
                              JSONScanner
                              JSONVisitor
                              Location
                              ModificationOptions
                              Node
                              ParseError
                              ParseOptions
                              Range

                              Type Aliases

                              EditResult
                              JSONPath
                              NodeType
                              Segment

                              Settings

                              Member Visibility

                              On This Page

                              Functions
                              Enumerations
                              Interfaces
                              Type Aliases
                              \ 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 ceff15f..062c3f7 100644 --- a/docs/modules/_runtime_data_format_msgpack.html +++ b/docs/modules/_runtime_data_format_msgpack.html @@ -1,32 +1,2 @@ -#runtime/data/format/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0
                              -

                                Package #runtime/data/format/msgpack

                                - -

                                - Index -

                                -                                 -
                                -

                                Classes

                                Decoder -Encoder -Packr -PackrStream -Unpackr -UnpackrStream -

                                Functions

                                addExtension -clearSource -decode -encode -pack -roundFloat32 -unpack -unpackMultiple -

                                Variables

                                C1 -isNativeAccelerationEnabled -RESERVE_START_SPACE -RESET_BUFFER_MODE -REUSE_BUFFER_MODE -

                                Enumerations

                                FLOAT32_OPTIONS -

                                Interfaces

                                Options -

                                Type Aliases

                                UnpackOptions -
                                -

                                Settings

                                Member Visibility
                                \ No newline at end of file +#runtime/data/format/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0
                                +

                                  Package #runtime/data/format/msgpack

                                  Classes

                                  Decoder
                                  Encoder
                                  Packr
                                  PackrStream
                                  Unpackr
                                  UnpackrStream

                                  Functions

                                  addExtension
                                  clearSource
                                  decode
                                  encode
                                  pack
                                  roundFloat32
                                  unpack
                                  unpackMultiple

                                  Variables

                                  C1
                                  isNativeAccelerationEnabled
                                  RESERVE_START_SPACE
                                  RESET_BUFFER_MODE
                                  REUSE_BUFFER_MODE

                                  Enumerations

                                  FLOAT32_OPTIONS

                                  Interfaces

                                  Options

                                  Type Aliases

                                  UnpackOptions

                                  Settings

                                  Member Visibility

                                  On This Page

                                  Classes
                                  Functions
                                  Variables
                                  Enumerations
                                  Interfaces
                                  Type Aliases
                                  \ 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 9e55153..8471561 100644 --- a/docs/modules/_runtime_data_format_msgpack_compress.html +++ b/docs/modules/_runtime_data_format_msgpack_compress.html @@ -1,14 +1,2 @@ -#runtime/data/format/msgpack/compress | TyphonJS Runtime Library (FVTT) 0.2.0
                                  -

                                    Package #runtime/data/format/msgpack/compress

                                    - -

                                    - Index -

                                    -                                     -
                                    -

                                    Functions

                                    inflateAndUnpack -inflateAndUnpackB64 -packAndDeflate -packAndDeflateB64 -
                                    -

                                    Settings

                                    Member Visibility
                                    \ No newline at end of file +#runtime/data/format/msgpack/compress | TyphonJS Runtime Library (FVTT) 0.2.0
                                    +

                                      Package #runtime/data/format/msgpack/compress

                                      Functions

                                      inflateAndUnpack
                                      inflateAndUnpackB64
                                      packAndDeflate
                                      packAndDeflateB64

                                      Settings

                                      Member Visibility

                                      On This Page

                                      Functions
                                      \ 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 d0d8155..60ebb94 100644 --- a/docs/modules/_runtime_data_format_unicode.html +++ b/docs/modules/_runtime_data_format_unicode.html @@ -1,12 +1,2 @@ -#runtime/data/format/unicode | TyphonJS Runtime Library (FVTT) 0.2.0
                                      -

                                        Package #runtime/data/format/unicode

                                        - -

                                        - Index -

                                        -                                         -
                                        -

                                        Functions

                                        graphemeIterator -graphemeSplit -
                                        -

                                        Settings

                                        Member Visibility
                                        \ No newline at end of file +#runtime/data/format/unicode | TyphonJS Runtime Library (FVTT) 0.2.0
                                        +

                                          Package #runtime/data/format/unicode

                                          Functions

                                          graphemeIterator
                                          graphemeSplit

                                          Settings

                                          Member Visibility

                                          On This Page

                                          Functions
                                          \ 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 deleted file mode 100644 index 503c029..0000000 --- a/docs/modules/_runtime_data_struct_cache_quick_lru.html +++ /dev/null @@ -1,12 +0,0 @@ -#runtime/data/struct/cache/quick-lru | TyphonJS Runtime Library (FVTT) 0.2.0
                                          -

                                            Package #runtime/data/struct/cache/quick-lru

                                            - -

                                            - Index -

                                            -                                             -
                                            -

                                            Classes

                                            QuickLRU -

                                            Type Aliases

                                            Options -
                                            -

                                            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 0973008..e8352ad 100644 --- a/docs/modules/_runtime_data_struct_hash_array.html +++ b/docs/modules/_runtime_data_struct_hash_array.html @@ -1,16 +1,2 @@ -#runtime/data/struct/hash/array | TyphonJS Runtime Library (FVTT) 0.2.0
                                            -

                                              Package #runtime/data/struct/hash/array

                                              - -

                                              - Index -

                                              -                                               -
                                              -

                                              Classes

                                              HashArray -HashArrayUtil -

                                              Functions

                                              getValueFromKey -

                                              Type Aliases

                                              HashArrayOptions -Key -KeyFields -
                                              -

                                              Settings

                                              Member Visibility
                                              \ No newline at end of file +#runtime/data/struct/hash/array | TyphonJS Runtime Library (FVTT) 0.2.0
                                              +

                                                Package #runtime/data/struct/hash/array

                                                Classes

                                                HashArray
                                                HashArrayUtil

                                                Functions

                                                getValueFromKey

                                                Type Aliases

                                                HashArrayOptions
                                                Key
                                                KeyFields

                                                Settings

                                                Member Visibility

                                                On This Page

                                                Classes
                                                Functions
                                                Type Aliases
                                                \ 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 f86c878..ae36918 100644 --- a/docs/modules/_runtime_data_struct_search_trie.html +++ b/docs/modules/_runtime_data_struct_search_trie.html @@ -1,13 +1,2 @@ -#runtime/data/struct/search/trie | TyphonJS Runtime Library (FVTT) 0.2.0
                                                -

                                                  Package #runtime/data/struct/search/trie

                                                  Classes

                                                  TrieSearch -UnionReducer -

                                                  Interfaces

                                                  TrieSearchReducer -

                                                  Type Aliases

                                                  TrieNode -TrieSearchOptions -TrieSearchReducerData -TrieSearchReducerResetData -TrieSearchSubscribeHandler -

                                                  References

                                                  getValueFromKey -Key -KeyFields -

                                                  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 +#runtime/data/struct/search/trie | TyphonJS Runtime Library (FVTT) 0.2.0
                                                  +

                                                    Package #runtime/data/struct/search/trie

                                                    Classes

                                                    TrieSearch
                                                    UnionReducer

                                                    Interfaces

                                                    TrieSearchReducer

                                                    Type Aliases

                                                    TrieNode
                                                    TrieSearchOptions
                                                    TrieSearchReducerData
                                                    TrieSearchReducerResetData
                                                    TrieSearchSubscribeHandler

                                                    References

                                                    getValueFromKey â†’ getValueFromKey
                                                    Key â†’ Key
                                                    KeyFields â†’ KeyFields

                                                    Settings

                                                    Member Visibility

                                                    On This Page

                                                    Classes
                                                    Interfaces
                                                    Type Aliases
                                                    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 0995157..cde295d 100644 --- a/docs/modules/_runtime_data_struct_search_trie_query.html +++ b/docs/modules/_runtime_data_struct_search_trie_query.html @@ -1,12 +1,2 @@ -#runtime/data/struct/search/trie/query | TyphonJS Runtime Library (FVTT) 0.2.0
                                                    -

                                                      Package #runtime/data/struct/search/trie/query

                                                      - -

                                                      - Index -

                                                      -                                                       -
                                                      -

                                                      Classes

                                                      TrieSearchQuery -

                                                      Type Aliases

                                                      TrieSearchQueryOptions -
                                                      -

                                                      Settings

                                                      Member Visibility
                                                      \ No newline at end of file +#runtime/data/struct/search/trie/query | TyphonJS Runtime Library (FVTT) 0.2.0
                                                      +

                                                        Package #runtime/data/struct/search/trie/query

                                                        Classes

                                                        TrieSearchQuery

                                                        Type Aliases

                                                        TrieSearchQueryOptions

                                                        Settings

                                                        Member Visibility

                                                        On This Page

                                                        Classes
                                                        Type Aliases
                                                        \ No newline at end of file diff --git a/docs/modules/_runtime_math_gl_matrix.html b/docs/modules/_runtime_math_gl_matrix.html deleted file mode 100644 index eafb87d..0000000 --- a/docs/modules/_runtime_math_gl_matrix.html +++ /dev/null @@ -1,30 +0,0 @@ -#runtime/math/gl-matrix | TyphonJS Runtime Library (FVTT) 0.2.0
                                                        -

                                                          Package #runtime/math/gl-matrix

                                                          Provides the gl-matrix 32-bit library.

                                                          -
                                                          - -

                                                          - Index -

                                                          -                                                           -
                                                          -

                                                          Classes

                                                          Mat2 -Mat2d -Mat3 -Mat4 -Quat -Quat2 -Vec2 -Vec3 -Vec4 -

                                                          Type Aliases

                                                          FloatArray -Mat2dLike -Mat2Like -Mat3Like -Mat4Like -Quat2Like -QuatLike -Vec2Like -Vec3Like -Vec4Like -
                                                          -

                                                          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 64665fa..8457287 100644 --- a/docs/modules/_runtime_math_interpolate.html +++ b/docs/modules/_runtime_math_interpolate.html @@ -1,13 +1,2 @@ -#runtime/math/interpolate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                          -

                                                            Package #runtime/math/interpolate

                                                            - -

                                                            - Index -

                                                            -                                                             -
                                                            -

                                                            Functions

                                                            lerp -

                                                            Interfaces

                                                            InterpolateFunction -

                                                            Type Aliases

                                                            InterpolateFunctionName -
                                                            -

                                                            Settings

                                                            Member Visibility
                                                            \ No newline at end of file +#runtime/math/interpolate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                            +

                                                              Package #runtime/math/interpolate

                                                              Functions

                                                              lerp

                                                              Interfaces

                                                              InterpolateFunction

                                                              Type Aliases

                                                              InterpolateFunctionName

                                                              Settings

                                                              Member Visibility

                                                              On This Page

                                                              Functions
                                                              Interfaces
                                                              Type Aliases
                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_math_physics.html b/docs/modules/_runtime_math_physics.html index 36263b5..09fdad6 100644 --- a/docs/modules/_runtime_math_physics.html +++ b/docs/modules/_runtime_math_physics.html @@ -1,11 +1,2 @@ -#runtime/math/physics | TyphonJS Runtime Library (FVTT) 0.2.0
                                                              -

                                                                Package #runtime/math/physics

                                                                - -

                                                                - Index -

                                                                -                                                                 -
                                                                -

                                                                Classes

                                                                TJSVelocityTrack -
                                                                -

                                                                Settings

                                                                Member Visibility
                                                                \ No newline at end of file +#runtime/math/physics | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                +

                                                                  Package #runtime/math/physics

                                                                  Classes

                                                                  TJSVelocityTrack

                                                                  Settings

                                                                  Member Visibility

                                                                  On This Page

                                                                  Classes
                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_math_util.html b/docs/modules/_runtime_math_util.html index 3d4fb95..a133a51 100644 --- a/docs/modules/_runtime_math_util.html +++ b/docs/modules/_runtime_math_util.html @@ -1,14 +1,2 @@ -#runtime/math/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                  -

                                                                    Package #runtime/math/util

                                                                    - -

                                                                    - Index -

                                                                    -                                                                     -
                                                                    -

                                                                    Classes

                                                                    MathRandom -

                                                                    Functions

                                                                    clamp -degToRad -radToDeg -
                                                                    -

                                                                    Settings

                                                                    Member Visibility
                                                                    \ No newline at end of file +#runtime/math/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                    +

                                                                      Package #runtime/math/util

                                                                      Classes

                                                                      MathRandom

                                                                      Functions

                                                                      clamp
                                                                      degToRad
                                                                      radToDeg

                                                                      Settings

                                                                      Member Visibility

                                                                      On This Page

                                                                      Classes
                                                                      Functions
                                                                      \ No newline at end of file diff --git a/docs/modules/_runtime_plugin_manager.html b/docs/modules/_runtime_plugin_manager.html index 3134d6c..32b98c4 100644 --- a/docs/modules/_runtime_plugin_manager.html +++ b/docs/modules/_runtime_plugin_manager.html @@ -1,27 +1,5 @@ -#runtime/plugin/manager | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                      -

                                                                        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

                                                                        +

                                                                          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 -

                                                                          -                                                                           -
                                                                          -

                                                                          Classes

                                                                          PluginInvokeEvent -PluginInvokeSupport -PluginManager -

                                                                          Functions

                                                                          escapeTarget -isValidConfig -

                                                                          Interfaces

                                                                          PluginSupportConstructor -PluginSupportImpl -

                                                                          Type Aliases

                                                                          DataOutPluginEnabled -DataOutPluginEvents -DataOutPluginRemoved -PluginConfig -PluginData -PluginEventData -PluginManagerOptions -
                                                                          -

                                                                          Settings

                                                                          Member Visibility
                                                                          \ No newline at end of file +

                                                                          Classes

                                                                          PluginInvokeEvent
                                                                          PluginInvokeSupport
                                                                          PluginManager

                                                                          Functions

                                                                          escapeTarget
                                                                          isValidConfig

                                                                          Interfaces

                                                                          PluginSupportConstructor
                                                                          PluginSupportImpl

                                                                          Type Aliases

                                                                          DataOutPluginEnabled
                                                                          DataOutPluginEvents
                                                                          DataOutPluginRemoved
                                                                          PluginConfig
                                                                          PluginData
                                                                          PluginEventData
                                                                          PluginManagerOptions

                                                                          Settings

                                                                          Member Visibility

                                                                          On This Page

                                                                          Classes
                                                                          Functions
                                                                          Interfaces
                                                                          Type Aliases
                                                                          \ 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 c960b29..dc1e794 100644 --- a/docs/modules/_runtime_plugin_manager_eventbus.html +++ b/docs/modules/_runtime_plugin_manager_eventbus.html @@ -1,25 +1,8 @@ -#runtime/plugin/manager/eventbus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                          -

                                                                            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

                                                                            +

                                                                              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 -

                                                                              -                                                                               -
                                                                              -

                                                                              Classes

                                                                              Eventbus -EventbusProxy -EventbusSecure -

                                                                              Type Aliases

                                                                              EventbusEvents -EventbusSecureObj -EventData -EventMap -EventOptions -EventOptionsOut -
                                                                              -

                                                                              Settings

                                                                              Member Visibility
                                                                              \ No newline at end of file +

                                                                              Classes

                                                                              Eventbus
                                                                              EventbusProxy
                                                                              EventbusSecure

                                                                              Type Aliases

                                                                              EventbusEvents
                                                                              EventbusSecureObj
                                                                              EventData
                                                                              EventMap
                                                                              EventOptions
                                                                              EventOptionsOut

                                                                              Settings

                                                                              Member Visibility

                                                                              On This Page

                                                                              Classes
                                                                              Type Aliases
                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom_focus.html b/docs/modules/_runtime_svelte_action_dom_focus.html index 850a093..418cf98 100644 --- a/docs/modules/_runtime_svelte_action_dom_focus.html +++ b/docs/modules/_runtime_svelte_action_dom_focus.html @@ -1,11 +1,2 @@ -#runtime/svelte/action/dom/focus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                              -

                                                                                Package #runtime/svelte/action/dom/focus

                                                                                - -

                                                                                - Index -

                                                                                -                                                                                 -
                                                                                -

                                                                                Functions

                                                                                isFocused -
                                                                                -

                                                                                Settings

                                                                                Member Visibility
                                                                                \ No newline at end of file +#runtime/svelte/action/dom/focus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                +

                                                                                  Package #runtime/svelte/action/dom/focus

                                                                                  Functions

                                                                                  isFocused

                                                                                  Settings

                                                                                  Member Visibility

                                                                                  On This Page

                                                                                  Functions
                                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom_input.html b/docs/modules/_runtime_svelte_action_dom_input.html index f4f5485..2a22d34 100644 --- a/docs/modules/_runtime_svelte_action_dom_input.html +++ b/docs/modules/_runtime_svelte_action_dom_input.html @@ -1,13 +1,2 @@ -#runtime/svelte/action/dom/input | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                  -

                                                                                    Package #runtime/svelte/action/dom/input

                                                                                    - -

                                                                                    - Index -

                                                                                    -                                                                                     -
                                                                                    -

                                                                                    Functions

                                                                                    keyforward -useTinykeys -

                                                                                    Type Aliases

                                                                                    UseTinykeysData -
                                                                                    -

                                                                                    Settings

                                                                                    Member Visibility
                                                                                    \ No newline at end of file +#runtime/svelte/action/dom/input | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                    +

                                                                                      Package #runtime/svelte/action/dom/input

                                                                                      Functions

                                                                                      keyforward
                                                                                      useTinykeys

                                                                                      Type Aliases

                                                                                      UseTinykeysData

                                                                                      Settings

                                                                                      Member Visibility

                                                                                      On This Page

                                                                                      Functions
                                                                                      Type Aliases
                                                                                      \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom_observer.html b/docs/modules/_runtime_svelte_action_dom_observer.html index da067c8..81203a7 100644 --- a/docs/modules/_runtime_svelte_action_dom_observer.html +++ b/docs/modules/_runtime_svelte_action_dom_observer.html @@ -1,12 +1,2 @@ -#runtime/svelte/action/dom/observer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                      -

                                                                                        Package #runtime/svelte/action/dom/observer

                                                                                        - -

                                                                                        - Index -

                                                                                        -                                                                                         -
                                                                                        -

                                                                                        Functions

                                                                                        resizeObserver -

                                                                                        Namespaces

                                                                                        resizeObserver -
                                                                                        -

                                                                                        Settings

                                                                                        Member Visibility
                                                                                        \ No newline at end of file +#runtime/svelte/action/dom/observer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                        +

                                                                                          Package #runtime/svelte/action/dom/observer

                                                                                          Functions

                                                                                          resizeObserver

                                                                                          Namespaces

                                                                                          resizeObserver

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Functions
                                                                                          Namespaces
                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom_observer.resizeObserver-1.html b/docs/modules/_runtime_svelte_action_dom_observer.resizeObserver-1.html index 3a45e62..7941edf 100644 --- a/docs/modules/_runtime_svelte_action_dom_observer.resizeObserver-1.html +++ b/docs/modules/_runtime_svelte_action_dom_observer.resizeObserver-1.html @@ -1,11 +1,2 @@ -resizeObserver | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                          -

                                                                                          Namespace resizeObserver

                                                                                          - -

                                                                                          - Index -

                                                                                          -                                                                                           -
                                                                                          -

                                                                                          Functions

                                                                                          updateCache -
                                                                                          -

                                                                                          Settings

                                                                                          Member Visibility
                                                                                          \ No newline at end of file +resizeObserver | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                          +

                                                                                          Namespace resizeObserver

                                                                                          Functions

                                                                                          updateCache

                                                                                          Settings

                                                                                          Member Visibility

                                                                                          On This Page

                                                                                          Functions
                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom_properties.html b/docs/modules/_runtime_svelte_action_dom_properties.html index 2c2409f..df70880 100644 --- a/docs/modules/_runtime_svelte_action_dom_properties.html +++ b/docs/modules/_runtime_svelte_action_dom_properties.html @@ -1,12 +1,2 @@ -#runtime/svelte/action/dom/properties | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                          -

                                                                                            Package #runtime/svelte/action/dom/properties

                                                                                            - -

                                                                                            - Index -

                                                                                            -                                                                                             -
                                                                                            -

                                                                                            Functions

                                                                                            applyScrolltop -toggleDetails -
                                                                                            -

                                                                                            Settings

                                                                                            Member Visibility
                                                                                            \ No newline at end of file +#runtime/svelte/action/dom/properties | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                            +

                                                                                              Package #runtime/svelte/action/dom/properties

                                                                                              Functions

                                                                                              applyScrolltop
                                                                                              toggleDetails

                                                                                              Settings

                                                                                              Member Visibility

                                                                                              On This Page

                                                                                              Functions
                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_action_dom_style.html b/docs/modules/_runtime_svelte_action_dom_style.html index 67c7d3a..8e70f63 100644 --- a/docs/modules/_runtime_svelte_action_dom_style.html +++ b/docs/modules/_runtime_svelte_action_dom_style.html @@ -1,11 +1,2 @@ -#runtime/svelte/action/dom/style | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                              -

                                                                                                Package #runtime/svelte/action/dom/style

                                                                                                - -

                                                                                                - Index -

                                                                                                -                                                                                                 -
                                                                                                -

                                                                                                Functions

                                                                                                applyStyles -
                                                                                                -

                                                                                                Settings

                                                                                                Member Visibility
                                                                                                \ No newline at end of file +#runtime/svelte/action/dom/style | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                +

                                                                                                  Package #runtime/svelte/action/dom/style

                                                                                                  Functions

                                                                                                  applyStyles

                                                                                                  Settings

                                                                                                  Member Visibility

                                                                                                  On This Page

                                                                                                  Functions
                                                                                                  \ 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 2b8eb02..c07c58f 100644 --- a/docs/modules/_runtime_svelte_action_util.html +++ b/docs/modules/_runtime_svelte_action_util.html @@ -1,12 +1,2 @@ -#runtime/svelte/action/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                  -

                                                                                                    Package #runtime/svelte/action/util

                                                                                                    - -

                                                                                                    - Index -

                                                                                                    -                                                                                                     -
                                                                                                    -

                                                                                                    Functions

                                                                                                    dynamicAction -

                                                                                                    Type Aliases

                                                                                                    DynamicActionOptions -
                                                                                                    -

                                                                                                    Settings

                                                                                                    Member Visibility
                                                                                                    \ No newline at end of file +#runtime/svelte/action/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                    +

                                                                                                      Package #runtime/svelte/action/util

                                                                                                      Functions

                                                                                                      dynamicAction

                                                                                                      Type Aliases

                                                                                                      DynamicActionOptions

                                                                                                      Settings

                                                                                                      Member Visibility

                                                                                                      On This Page

                                                                                                      Functions
                                                                                                      Type Aliases
                                                                                                      \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate.html b/docs/modules/_runtime_svelte_animate.html index 9be192d..1a4aa6f 100644 --- a/docs/modules/_runtime_svelte_animate.html +++ b/docs/modules/_runtime_svelte_animate.html @@ -1,11 +1,2 @@ -#runtime/svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                      -

                                                                                                        Package #runtime/svelte/animate

                                                                                                        - -

                                                                                                        - Index -

                                                                                                        -                                                                                                         -
                                                                                                        -

                                                                                                        Functions

                                                                                                        animateEvents -
                                                                                                        -

                                                                                                        Settings

                                                                                                        Member Visibility
                                                                                                        \ No newline at end of file +#runtime/svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                        +

                                                                                                          Package #runtime/svelte/animate

                                                                                                          Functions

                                                                                                          animateEvents

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Functions
                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate_gsap.Action.html b/docs/modules/_runtime_svelte_animate_gsap.Action.html index c18353e..1a7a9ad 100644 --- a/docs/modules/_runtime_svelte_animate_gsap.Action.html +++ b/docs/modules/_runtime_svelte_animate_gsap.Action.html @@ -1,15 +1,3 @@ -Action | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          -

                                                                                                          Namespace Action

                                                                                                          Defines the types for the draggableGsap action.

                                                                                                          -
                                                                                                          - -

                                                                                                          - Index -

                                                                                                          -                                                                                                           -
                                                                                                          -

                                                                                                          Interfaces

                                                                                                          DraggableGsapOptionsStore -

                                                                                                          Type Aliases

                                                                                                          DraggableGsapOptions -GsapInertiaOptions -GsapTweenOptions -
                                                                                                          -

                                                                                                          Settings

                                                                                                          Member Visibility
                                                                                                          \ No newline at end of file +Action | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          +

                                                                                                          Namespace Action

                                                                                                          Defines the types for the draggableGsap action.

                                                                                                          +

                                                                                                          Interfaces

                                                                                                          DraggableGsapOptionsStore

                                                                                                          Type Aliases

                                                                                                          DraggableGsapOptions
                                                                                                          GsapInertiaOptions
                                                                                                          GsapTweenOptions

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Interfaces
                                                                                                          Type Aliases
                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate_gsap.Compose.html b/docs/modules/_runtime_svelte_animate_gsap.Compose.html index 425e0e2..3bc52fe 100644 --- a/docs/modules/_runtime_svelte_animate_gsap.Compose.html +++ b/docs/modules/_runtime_svelte_animate_gsap.Compose.html @@ -1,14 +1,3 @@ -Compose | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          -

                                                                                                          Namespace Compose

                                                                                                          Defines the types for GsapCompose.

                                                                                                          -
                                                                                                          - -

                                                                                                          - Index -

                                                                                                          -                                                                                                           -
                                                                                                          -

                                                                                                          Type Aliases

                                                                                                          GsapData -GsapPositionOptions -GsapTarget -
                                                                                                          -

                                                                                                          Settings

                                                                                                          Member Visibility
                                                                                                          \ No newline at end of file +Compose | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          +

                                                                                                          Namespace Compose

                                                                                                          Defines the types for GsapCompose.

                                                                                                          +

                                                                                                          Type Aliases

                                                                                                          GsapData
                                                                                                          GsapPositionOptions
                                                                                                          GsapTarget

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Type Aliases
                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate_gsap.draggableGsap-1.html b/docs/modules/_runtime_svelte_animate_gsap.draggableGsap-1.html index 4c1abfb..18cdc6e 100644 --- a/docs/modules/_runtime_svelte_animate_gsap.draggableGsap-1.html +++ b/docs/modules/_runtime_svelte_animate_gsap.draggableGsap-1.html @@ -1,11 +1,2 @@ -draggableGsap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          -

                                                                                                          Namespace draggableGsap

                                                                                                          - -

                                                                                                          - Index -

                                                                                                          -                                                                                                           -
                                                                                                          -

                                                                                                          Functions

                                                                                                          options -
                                                                                                          -

                                                                                                          Settings

                                                                                                          Member Visibility
                                                                                                          \ No newline at end of file +draggableGsap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          +

                                                                                                          Namespace draggableGsap

                                                                                                          Functions

                                                                                                          options

                                                                                                          Settings

                                                                                                          Member Visibility

                                                                                                          On This Page

                                                                                                          Functions
                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate_gsap.html b/docs/modules/_runtime_svelte_animate_gsap.html index 83de945..d444791 100644 --- a/docs/modules/_runtime_svelte_animate_gsap.html +++ b/docs/modules/_runtime_svelte_animate_gsap.html @@ -1,26 +1,7 @@ -#runtime/svelte/animate/gsap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                          -

                                                                                                            Package #runtime/svelte/animate/gsap

                                                                                                            Documentation: https://greensock.com/docs/v3

                                                                                                            +#runtime/svelte/animate/gsap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                            +

                                                                                                              Package #runtime/svelte/animate/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 -

                                                                                                              -                                                                                                               -
                                                                                                              -

                                                                                                              Classes

                                                                                                              GsapCompose -

                                                                                                              Functions

                                                                                                              draggableGsap -getGsapEasingFunc -

                                                                                                              Namespaces

                                                                                                              Action -Compose -draggableGsap -

                                                                                                              Variables

                                                                                                              gsap -gsapEasingFunc -gsapEasingList -

                                                                                                              Type Aliases

                                                                                                              GsapEasingFunctionName -GsapEasingReference -
                                                                                                              -

                                                                                                              Settings

                                                                                                              Member Visibility
                                                                                                              \ No newline at end of file +

                                                                                                              Classes

                                                                                                              GsapCompose

                                                                                                              Functions

                                                                                                              draggableGsap
                                                                                                              getGsapEasingFunc

                                                                                                              Namespaces

                                                                                                              Action
                                                                                                              Compose
                                                                                                              draggableGsap

                                                                                                              Variables

                                                                                                              gsap
                                                                                                              gsapEasingFunc
                                                                                                              gsapEasingList

                                                                                                              Type Aliases

                                                                                                              GsapEasingFunctionName
                                                                                                              GsapEasingReference

                                                                                                              Settings

                                                                                                              Member Visibility

                                                                                                              On This Page

                                                                                                              Classes
                                                                                                              Functions
                                                                                                              Namespaces
                                                                                                              Variables
                                                                                                              Type Aliases
                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate_gsap_plugin.html b/docs/modules/_runtime_svelte_animate_gsap_plugin.html index ce21060..95d1b10 100644 --- a/docs/modules/_runtime_svelte_animate_gsap_plugin.html +++ b/docs/modules/_runtime_svelte_animate_gsap_plugin.html @@ -1,5 +1,5 @@ -#runtime/svelte/animate/gsap/plugin | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                              -

                                                                                                                Package #runtime/svelte/animate/gsap/plugin

                                                                                                                Documentation: https://greensock.com/docs/v3/Plugins

                                                                                                                +#runtime/svelte/animate/gsap/plugin | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                +

                                                                                                                  Package #runtime/svelte/animate/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:

                                                                                                                  @@ -17,7 +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/animate/gsap/plugin/CustomEase';
                                                                                                                  import '#runtime/svelte/animate/gsap/plugin/MotionPathPlugin';
+

                                                                                                                  Example

                                                                                                                  // To load a plugin simply import the plugin and it will be available from `gsap` and `GsapCompose`.
                                                                                                                  import '#runtime/svelte/animate/gsap/plugin/CustomEase';
                                                                                                                  import '#runtime/svelte/animate/gsap/plugin/MotionPathPlugin';
                                                                                                                  -

                                                                                                                  Settings

                                                                                                                  Member Visibility
                                                                                                                  \ No newline at end of file +

                                                                                                                  Settings

                                                                                                                  Member Visibility
                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_animate_gsap_plugin_bonus.html b/docs/modules/_runtime_svelte_animate_gsap_plugin_bonus.html index 72e1e57..ffc6a7d 100644 --- a/docs/modules/_runtime_svelte_animate_gsap_plugin_bonus.html +++ b/docs/modules/_runtime_svelte_animate_gsap_plugin_bonus.html @@ -1,5 +1,5 @@ -#runtime/svelte/animate/gsap/plugin/bonus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                  -

                                                                                                                    Package #runtime/svelte/animate/gsap/plugin/bonus

                                                                                                                    Documentation: https://greensock.com/docs/v3/Plugins

                                                                                                                    +#runtime/svelte/animate/gsap/plugin/bonus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                    +

                                                                                                                      Package #runtime/svelte/animate/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.

                                                                                                                      @@ -18,7 +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/animate/gsap/plugin/bonus/CustomWiggle';
+

                                                                                                                      Example

                                                                                                                      // To load a plugin simply import the plugin and it will be available from `gsap` and `GsapCompose`.
                                                                                                                      import '#runtime/svelte/animate/gsap/plugin/bonus/CustomWiggle';
                                                                                                                      -

                                                                                                                      Settings

                                                                                                                      Member Visibility
                                                                                                                      \ 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 bd59434..3104d15 100644 --- a/docs/modules/_runtime_svelte_application.html +++ b/docs/modules/_runtime_svelte_application.html @@ -1,27 +1,2 @@ -#runtime/svelte/application | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                      -

                                                                                                                        Package #runtime/svelte/application

                                                                                                                        - -

                                                                                                                        - Index -

                                                                                                                        -                                                                                                                         -
                                                                                                                        -

                                                                                                                        Classes

                                                                                                                        SvelteApplication -TJSDialog -

                                                                                                                        Interfaces

                                                                                                                        ApplicationState -GetSvelteData -SvelteReactive -TJSDialogData -

                                                                                                                        Type Aliases

                                                                                                                        ApplicationStateData -MountedAppShell -StoreAppOptions -StoreUIOptions -SvelteApplicationOptions -SvelteData -SvelteReactiveData -TJSDialogButtonData -TJSDialogModalOptions -TJSDialogOptions -TJSDialogTransitionOptions -
                                                                                                                        -

                                                                                                                        Settings

                                                                                                                        Member Visibility
                                                                                                                        \ No newline at end of file +#runtime/svelte/application | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                        +

                                                                                                                          Package #runtime/svelte/application

                                                                                                                          Classes

                                                                                                                          SvelteApplication
                                                                                                                          TJSDialog

                                                                                                                          Interfaces

                                                                                                                          ApplicationState
                                                                                                                          GetSvelteData
                                                                                                                          SvelteReactive
                                                                                                                          TJSDialogData

                                                                                                                          Type Aliases

                                                                                                                          ApplicationStateData
                                                                                                                          MountedAppShell
                                                                                                                          StoreAppOptions
                                                                                                                          StoreUIOptions
                                                                                                                          SvelteApplicationOptions
                                                                                                                          SvelteData
                                                                                                                          SvelteReactiveData
                                                                                                                          TJSDialogButtonData
                                                                                                                          TJSDialogModalOptions
                                                                                                                          TJSDialogOptions
                                                                                                                          TJSDialogTransitionOptions

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Classes
                                                                                                                          Interfaces
                                                                                                                          Type Aliases
                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_application.ApplicationShell-1.html b/docs/modules/_runtime_svelte_component_application.ApplicationShell-1.html index 2dc278d..5cbbda0 100644 --- a/docs/modules/_runtime_svelte_component_application.ApplicationShell-1.html +++ b/docs/modules/_runtime_svelte_component_application.ApplicationShell-1.html @@ -1,14 +1,3 @@ -ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          -

                                                                                                                          Namespace ApplicationShell

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          -
                                                                                                                          - -

                                                                                                                          - Index -

                                                                                                                          -                                                                                                                           -
                                                                                                                          -

                                                                                                                          Type Aliases

                                                                                                                          Events -Props -Slots -
                                                                                                                          -

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          \ No newline at end of file +ApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          +

                                                                                                                          Namespace ApplicationShell

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          +

                                                                                                                          Type Aliases

                                                                                                                          Events
                                                                                                                          Props
                                                                                                                          Slots

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Type Aliases
                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_application.EmptyApplicationShell-1.html b/docs/modules/_runtime_svelte_component_application.EmptyApplicationShell-1.html index 27d45fe..989d461 100644 --- a/docs/modules/_runtime_svelte_component_application.EmptyApplicationShell-1.html +++ b/docs/modules/_runtime_svelte_component_application.EmptyApplicationShell-1.html @@ -1,14 +1,3 @@ -EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          -

                                                                                                                          Namespace EmptyApplicationShell

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          -
                                                                                                                          - -

                                                                                                                          - Index -

                                                                                                                          -                                                                                                                           -
                                                                                                                          -

                                                                                                                          Type Aliases

                                                                                                                          Events -Props -Slots -
                                                                                                                          -

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          \ No newline at end of file +EmptyApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          +

                                                                                                                          Namespace EmptyApplicationShell

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          +

                                                                                                                          Type Aliases

                                                                                                                          Events
                                                                                                                          Props
                                                                                                                          Slots

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Type Aliases
                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_application.TJSApplicationShell-1.html b/docs/modules/_runtime_svelte_component_application.TJSApplicationShell-1.html index 7d811b6..7065ac6 100644 --- a/docs/modules/_runtime_svelte_component_application.TJSApplicationShell-1.html +++ b/docs/modules/_runtime_svelte_component_application.TJSApplicationShell-1.html @@ -1,14 +1,3 @@ -TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          -

                                                                                                                          Namespace TJSApplicationShell

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          -
                                                                                                                          - -

                                                                                                                          - Index -

                                                                                                                          -                                                                                                                           -
                                                                                                                          -

                                                                                                                          Type Aliases

                                                                                                                          Events -Props -Slots -
                                                                                                                          -

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          \ No newline at end of file +TJSApplicationShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          +

                                                                                                                          Namespace TJSApplicationShell

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          +

                                                                                                                          Type Aliases

                                                                                                                          Events
                                                                                                                          Props
                                                                                                                          Slots

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Type Aliases
                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_application.TJSGlassPane-1.html b/docs/modules/_runtime_svelte_component_application.TJSGlassPane-1.html index 8180645..d98e9ad 100644 --- a/docs/modules/_runtime_svelte_component_application.TJSGlassPane-1.html +++ b/docs/modules/_runtime_svelte_component_application.TJSGlassPane-1.html @@ -1,14 +1,3 @@ -TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          -

                                                                                                                          Namespace TJSGlassPane

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          -
                                                                                                                          - -

                                                                                                                          - Index -

                                                                                                                          -                                                                                                                           -
                                                                                                                          -

                                                                                                                          Type Aliases

                                                                                                                          Events -Props -Slots -
                                                                                                                          -

                                                                                                                          Settings

                                                                                                                          Member Visibility
                                                                                                                          \ No newline at end of file +TJSGlassPane | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          +

                                                                                                                          Namespace TJSGlassPane

                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                          +

                                                                                                                          Type Aliases

                                                                                                                          Events
                                                                                                                          Props
                                                                                                                          Slots

                                                                                                                          Settings

                                                                                                                          Member Visibility

                                                                                                                          On This Page

                                                                                                                          Type Aliases
                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_component_application.html b/docs/modules/_runtime_svelte_component_application.html index 5e51972..ff37375 100644 --- a/docs/modules/_runtime_svelte_component_application.html +++ b/docs/modules/_runtime_svelte_component_application.html @@ -1,18 +1,2 @@ -#runtime/svelte/component/application | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                          -

                                                                                                                            Package #runtime/svelte/component/application

                                                                                                                            - -

                                                                                                                            - Index -

                                                                                                                            -                                                                                                                             -
                                                                                                                            -

                                                                                                                            Classes

                                                                                                                            ApplicationShell -EmptyApplicationShell -TJSApplicationShell -TJSGlassPane -

                                                                                                                            Namespaces

                                                                                                                            ApplicationShell -EmptyApplicationShell -TJSApplicationShell -TJSGlassPane -
                                                                                                                            -

                                                                                                                            Settings

                                                                                                                            Member Visibility
                                                                                                                            \ No newline at end of file +#runtime/svelte/component/application | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                            +

                                                                                                                              Package #runtime/svelte/component/application

                                                                                                                              Classes

                                                                                                                              ApplicationShell
                                                                                                                              EmptyApplicationShell
                                                                                                                              TJSApplicationShell
                                                                                                                              TJSGlassPane

                                                                                                                              Namespaces

                                                                                                                              ApplicationShell
                                                                                                                              EmptyApplicationShell
                                                                                                                              TJSApplicationShell
                                                                                                                              TJSGlassPane

                                                                                                                              Settings

                                                                                                                              Member Visibility

                                                                                                                              On This Page

                                                                                                                              Classes
                                                                                                                              Namespaces
                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_easing.html b/docs/modules/_runtime_svelte_easing.html index 38627af..6f372a4 100644 --- a/docs/modules/_runtime_svelte_easing.html +++ b/docs/modules/_runtime_svelte_easing.html @@ -1,11 +1,5 @@ -#runtime/svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                              -

                                                                                                                                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

                                                                                                                                +

                                                                                                                                  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 -

                                                                                                                                  Variables

                                                                                                                                  easingFunc -easingList -

                                                                                                                                  Type Aliases

                                                                                                                                  EasingFunctionName -EasingReference -

                                                                                                                                  References

                                                                                                                                  EasingFunction -

                                                                                                                                  References

                                                                                                                                  EasingFunction

                                                                                                                                  Re-exports EasingFunction

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  References
                                                                                                                                  \ No newline at end of file +

                                                                                                                                  Functions

                                                                                                                                  getEasingFunc

                                                                                                                                  Variables

                                                                                                                                  easingFunc
                                                                                                                                  easingList

                                                                                                                                  Type Aliases

                                                                                                                                  EasingFunctionName
                                                                                                                                  EasingReference

                                                                                                                                  References

                                                                                                                                  EasingFunction â†’ EasingFunction

                                                                                                                                  Settings

                                                                                                                                  Member Visibility

                                                                                                                                  On This Page

                                                                                                                                  Functions
                                                                                                                                  Variables
                                                                                                                                  Type Aliases
                                                                                                                                  References
                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_dom_input.html b/docs/modules/_runtime_svelte_store_dom_input.html index 52b7246..c0985c6 100644 --- a/docs/modules/_runtime_svelte_store_dom_input.html +++ b/docs/modules/_runtime_svelte_store_dom_input.html @@ -1,12 +1,2 @@ -#runtime/svelte/store/dom/input | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                  -

                                                                                                                                    Package #runtime/svelte/store/dom/input

                                                                                                                                    - -

                                                                                                                                    - Index -

                                                                                                                                    -                                                                                                                                     -
                                                                                                                                    -

                                                                                                                                    Classes

                                                                                                                                    KeyStore -

                                                                                                                                    Type Aliases

                                                                                                                                    KeyStoreOptions -
                                                                                                                                    -

                                                                                                                                    Settings

                                                                                                                                    Member Visibility
                                                                                                                                    \ No newline at end of file +#runtime/svelte/store/dom/input | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                    +

                                                                                                                                      Package #runtime/svelte/store/dom/input

                                                                                                                                      Classes

                                                                                                                                      KeyStore

                                                                                                                                      Type Aliases

                                                                                                                                      KeyStoreOptions

                                                                                                                                      Settings

                                                                                                                                      Member Visibility

                                                                                                                                      On This Page

                                                                                                                                      Classes
                                                                                                                                      Type Aliases
                                                                                                                                      \ 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 b1dec1d..9b707b7 100644 --- a/docs/modules/_runtime_svelte_store_fvtt_document.html +++ b/docs/modules/_runtime_svelte_store_fvtt_document.html @@ -1,18 +1,2 @@ -#runtime/svelte/store/fvtt/document | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                      -

                                                                                                                                        Package #runtime/svelte/store/fvtt/document

                                                                                                                                        - -

                                                                                                                                        - Index -

                                                                                                                                        -                                                                                                                                         -
                                                                                                                                        -

                                                                                                                                        Classes

                                                                                                                                        TJSDocument -TJSDocumentCollection -

                                                                                                                                        Interfaces

                                                                                                                                        EmbeddedAPI -NamedDocumentConstructor -

                                                                                                                                        Type Aliases

                                                                                                                                        TJSDocumentCollectionOptions -TJSDocumentCollectionUpdateOptions -TJSDocumentOptions -TJSDocumentUpdateOptions -
                                                                                                                                        -

                                                                                                                                        Settings

                                                                                                                                        Member Visibility
                                                                                                                                        \ No newline at end of file +#runtime/svelte/store/fvtt/document | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                        +

                                                                                                                                          Package #runtime/svelte/store/fvtt/document

                                                                                                                                          Classes

                                                                                                                                          TJSDocument
                                                                                                                                          TJSDocumentCollection

                                                                                                                                          Interfaces

                                                                                                                                          EmbeddedAPI
                                                                                                                                          NamedDocumentConstructor

                                                                                                                                          Type Aliases

                                                                                                                                          TJSDocumentCollectionOptions
                                                                                                                                          TJSDocumentCollectionUpdateOptions
                                                                                                                                          TJSDocumentOptions
                                                                                                                                          TJSDocumentUpdateOptions

                                                                                                                                          Settings

                                                                                                                                          Member Visibility

                                                                                                                                          On This Page

                                                                                                                                          Classes
                                                                                                                                          Interfaces
                                                                                                                                          Type Aliases
                                                                                                                                          \ 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 4d29f34..40db57a 100644 --- a/docs/modules/_runtime_svelte_store_fvtt_settings.html +++ b/docs/modules/_runtime_svelte_store_fvtt_settings.html @@ -1,15 +1,2 @@ -#runtime/svelte/store/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                          -

                                                                                                                                            Package #runtime/svelte/store/fvtt/settings

                                                                                                                                            - -

                                                                                                                                            - Index -

                                                                                                                                            -                                                                                                                                             -
                                                                                                                                            -

                                                                                                                                            Classes

                                                                                                                                            TJSGameSettings -TJSLiveGameSettings -

                                                                                                                                            Type Aliases

                                                                                                                                            GameSetting -GameSettingData -GameSettingOptions -
                                                                                                                                            -

                                                                                                                                            Settings

                                                                                                                                            Member Visibility
                                                                                                                                            \ No newline at end of file +#runtime/svelte/store/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                            +

                                                                                                                                              Package #runtime/svelte/store/fvtt/settings

                                                                                                                                              Classes

                                                                                                                                              TJSGameSettings
                                                                                                                                              TJSLiveGameSettings

                                                                                                                                              Type Aliases

                                                                                                                                              GameSetting
                                                                                                                                              GameSettingData
                                                                                                                                              GameSettingOptions

                                                                                                                                              Settings

                                                                                                                                              Member Visibility

                                                                                                                                              On This Page

                                                                                                                                              Classes
                                                                                                                                              Type Aliases
                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_fvtt_settings_world.html b/docs/modules/_runtime_svelte_store_fvtt_settings_world.html index 1c99725..d681f9e 100644 --- a/docs/modules/_runtime_svelte_store_fvtt_settings_world.html +++ b/docs/modules/_runtime_svelte_store_fvtt_settings_world.html @@ -1,11 +1,2 @@ -#runtime/svelte/store/fvtt/settings/world | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                              -

                                                                                                                                                Package #runtime/svelte/store/fvtt/settings/world

                                                                                                                                                - -

                                                                                                                                                - Index -

                                                                                                                                                -                                                                                                                                                 -
                                                                                                                                                -

                                                                                                                                                Classes

                                                                                                                                                WorldSettingArrayStore -
                                                                                                                                                -

                                                                                                                                                Settings

                                                                                                                                                Member Visibility
                                                                                                                                                \ No newline at end of file +#runtime/svelte/store/fvtt/settings/world | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                +

                                                                                                                                                  Package #runtime/svelte/store/fvtt/settings/world

                                                                                                                                                  Classes

                                                                                                                                                  WorldSettingArrayStore

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Classes
                                                                                                                                                  \ 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 7c2a6c0..949ddd3 100644 --- a/docs/modules/_runtime_svelte_store_position.Action.html +++ b/docs/modules/_runtime_svelte_store_position.Action.html @@ -1,12 +1,2 @@ -Action | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  Namespace Action

                                                                                                                                                  - -

                                                                                                                                                  - Index -

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -

                                                                                                                                                  Interfaces

                                                                                                                                                  DraggableOptionsStore -

                                                                                                                                                  Type Aliases

                                                                                                                                                  DraggableOptions -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +Action | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace Action

                                                                                                                                                  Interfaces

                                                                                                                                                  DraggableOptionsStore

                                                                                                                                                  Type Aliases

                                                                                                                                                  DraggableOptions

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  Type Aliases
                                                                                                                                                  \ 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 4bd1d84..26871f6 100644 --- a/docs/modules/_runtime_svelte_store_position.AnimationAPI-1.html +++ b/docs/modules/_runtime_svelte_store_position.AnimationAPI-1.html @@ -1,20 +1,2 @@ -AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  Namespace AnimationAPI

                                                                                                                                                  - -

                                                                                                                                                  - Index -

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -

                                                                                                                                                  Interfaces

                                                                                                                                                  GroupDataCallback -GroupQuickToCallback -GroupQuickTweenOptionsCallback -GroupTweenOptionsCallback -QuickToCallback -

                                                                                                                                                  Type Aliases

                                                                                                                                                  AnimationKey -GroupCallbackOptions -QuickTweenOptions -ScheduleOptions -TweenOptions -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +AnimationAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace AnimationAPI

                                                                                                                                                  Interfaces

                                                                                                                                                  GroupDataCallback
                                                                                                                                                  GroupQuickToCallback
                                                                                                                                                  GroupQuickTweenOptionsCallback
                                                                                                                                                  GroupTweenOptionsCallback
                                                                                                                                                  QuickToCallback

                                                                                                                                                  Type Aliases

                                                                                                                                                  AnimationKey
                                                                                                                                                  GroupCallbackOptions
                                                                                                                                                  QuickTweenOptions
                                                                                                                                                  ScheduleOptions
                                                                                                                                                  TweenOptions

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  Type Aliases
                                                                                                                                                  \ 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 cb26092..391dcc4 100644 --- a/docs/modules/_runtime_svelte_store_position.Data.html +++ b/docs/modules/_runtime_svelte_store_position.Data.html @@ -1,15 +1,3 @@ -Data | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  Namespace Data

                                                                                                                                                  Defines the data objects / interfaces used by various TJSPosition APIs.

                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  - Index -

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -

                                                                                                                                                  Interfaces

                                                                                                                                                  TJSPositionData -TJSPositionDataConstructor -TJSPositionDataExtra -

                                                                                                                                                  Type Aliases

                                                                                                                                                  TJSPositionDataRelative -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +Data | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace Data

                                                                                                                                                  Defines the data objects / interfaces used by various TJSPosition APIs.

                                                                                                                                                  +

                                                                                                                                                  Interfaces

                                                                                                                                                  TJSPositionData
                                                                                                                                                  TJSPositionDataConstructor
                                                                                                                                                  TJSPositionDataExtra

                                                                                                                                                  Type Aliases

                                                                                                                                                  TJSPositionDataRelative

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  Type Aliases
                                                                                                                                                  \ 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 019fcd7..1bf5d16 100644 --- a/docs/modules/_runtime_svelte_store_position.System.Initial.html +++ b/docs/modules/_runtime_svelte_store_position.System.Initial.html @@ -1,16 +1,6 @@ -Initial | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  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 +Initial | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                  +

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

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Interfaces

                                                                                                                                                  InitialSystem
                                                                                                                                                  InitialSystemConstructor

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  \ 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 b54c578..c343a72 100644 --- a/docs/modules/_runtime_svelte_store_position.System.Validator.html +++ b/docs/modules/_runtime_svelte_store_position.System.Validator.html @@ -1,16 +1,6 @@ -Validator | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  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 +Validator | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                  +

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

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                  Interfaces

                                                                                                                                                  ValidatorSystem
                                                                                                                                                  ValidatorSystemConstructor

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  \ 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 d1d6647..b0b3005 100644 --- a/docs/modules/_runtime_svelte_store_position.System.html +++ b/docs/modules/_runtime_svelte_store_position.System.html @@ -1,18 +1,6 @@ -System | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  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

                                                                                                                                                  +

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

                                                                                                                                                  Interfaces

                                                                                                                                                  SystemBase -SystemBaseConstructor -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +via TJSPosition.Initial and browser window / element bounds validation with and without transform support +available via TJSPosition.Validators.

                                                                                                                                                  +

                                                                                                                                                  Namespaces

                                                                                                                                                  Initial
                                                                                                                                                  Validator

                                                                                                                                                  Interfaces

                                                                                                                                                  SystemBase
                                                                                                                                                  SystemBaseConstructor

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Namespaces
                                                                                                                                                  Interfaces
                                                                                                                                                  \ 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 ab58bee..2a95320 100644 --- a/docs/modules/_runtime_svelte_store_position.TJSPositionTypes.html +++ b/docs/modules/_runtime_svelte_store_position.TJSPositionTypes.html @@ -1,22 +1,3 @@ -TJSPositionTypes | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  Namespace TJSPositionTypes

                                                                                                                                                  Provides all interfaces and type aliases used by TJSPosition.

                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  - Index -

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -

                                                                                                                                                  Interfaces

                                                                                                                                                  Positionable -TJSPositionWritable -

                                                                                                                                                  Type Aliases

                                                                                                                                                  OptionsCtor -OptionsCtorAll -OptionsGet -OptionsSet -PositionGroup -PositionInitial -PositionParent -PositionValidators -Stores -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +TJSPositionTypes | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace TJSPositionTypes

                                                                                                                                                  Provides all interfaces and type aliases used by TJSPosition.

                                                                                                                                                  +

                                                                                                                                                  Interfaces

                                                                                                                                                  Positionable
                                                                                                                                                  TJSPositionWritable

                                                                                                                                                  Type Aliases

                                                                                                                                                  OptionsCtor
                                                                                                                                                  OptionsCtorAll
                                                                                                                                                  OptionsGet
                                                                                                                                                  OptionsSet
                                                                                                                                                  PositionGroup
                                                                                                                                                  PositionInitial
                                                                                                                                                  PositionParent
                                                                                                                                                  PositionValidators
                                                                                                                                                  Stores

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  Type Aliases
                                                                                                                                                  \ 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 9b498a2..7542951 100644 --- a/docs/modules/_runtime_svelte_store_position.TransformAPI-1.html +++ b/docs/modules/_runtime_svelte_store_position.TransformAPI-1.html @@ -1,15 +1,3 @@ -TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  Namespace TransformAPI

                                                                                                                                                  Provides additional interfaces and type aliases for the transform API.

                                                                                                                                                  -
                                                                                                                                                  - -

                                                                                                                                                  - Index -

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -

                                                                                                                                                  Interfaces

                                                                                                                                                  TransformData -TransformDataConstructor -TransformOriginWritable -

                                                                                                                                                  Type Aliases

                                                                                                                                                  TransformOrigin -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +TransformAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace TransformAPI

                                                                                                                                                  Provides additional interfaces and type aliases for the transform API.

                                                                                                                                                  +

                                                                                                                                                  Interfaces

                                                                                                                                                  TransformData
                                                                                                                                                  TransformDataConstructor
                                                                                                                                                  TransformOriginWritable

                                                                                                                                                  Type Aliases

                                                                                                                                                  TransformOrigin

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  Type Aliases
                                                                                                                                                  \ 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 1a2b7c5..295a04e 100644 --- a/docs/modules/_runtime_svelte_store_position.ValidatorAPI-1.html +++ b/docs/modules/_runtime_svelte_store_position.ValidatorAPI-1.html @@ -1,16 +1,3 @@ -ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  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
                                                                                                                                                  \ No newline at end of file +ValidatorAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace ValidatorAPI

                                                                                                                                                  Provides a namespace for all type aliases related to the validator API.

                                                                                                                                                  +

                                                                                                                                                  Interfaces

                                                                                                                                                  ValidatorFn

                                                                                                                                                  Type Aliases

                                                                                                                                                  RemoveByCallback
                                                                                                                                                  ValidationData
                                                                                                                                                  ValidatorData
                                                                                                                                                  ValidatorOption

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Interfaces
                                                                                                                                                  Type Aliases
                                                                                                                                                  \ 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 508c6a6..2cb2370 100644 --- a/docs/modules/_runtime_svelte_store_position.draggable-1.html +++ b/docs/modules/_runtime_svelte_store_position.draggable-1.html @@ -1,11 +1,2 @@ -draggable | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                  Namespace draggable

                                                                                                                                                  - -

                                                                                                                                                  - Index -

                                                                                                                                                  -                                                                                                                                                   -
                                                                                                                                                  -

                                                                                                                                                  Functions

                                                                                                                                                  options -
                                                                                                                                                  -

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility
                                                                                                                                                  \ No newline at end of file +draggable | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  +

                                                                                                                                                  Namespace draggable

                                                                                                                                                  Functions

                                                                                                                                                  options

                                                                                                                                                  Settings

                                                                                                                                                  Member Visibility

                                                                                                                                                  On This Page

                                                                                                                                                  Functions
                                                                                                                                                  \ 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 4428e59..e6d8392 100644 --- a/docs/modules/_runtime_svelte_store_position.html +++ b/docs/modules/_runtime_svelte_store_position.html @@ -1,30 +1,6 @@ -#runtime/svelte/store/position | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                  -

                                                                                                                                                    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

                                                                                                                                                    +

                                                                                                                                                      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 -

                                                                                                                                                      -                                                                                                                                                       -
                                                                                                                                                      -

                                                                                                                                                      Classes

                                                                                                                                                      TJSPosition -

                                                                                                                                                      Functions

                                                                                                                                                      applyPosition -draggable -

                                                                                                                                                      Namespaces

                                                                                                                                                      Action -AnimationAPI -Data -draggable -System -TJSPositionTypes -TransformAPI -ValidatorAPI -

                                                                                                                                                      Interfaces

                                                                                                                                                      AnimationAPI -AnimationGroupAPI -PositionStateAPI -TransformAPI -ValidatorAPI -
                                                                                                                                                      -

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility
                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                      Classes

                                                                                                                                                      TJSPosition

                                                                                                                                                      Functions

                                                                                                                                                      applyPosition
                                                                                                                                                      draggable

                                                                                                                                                      Namespaces

                                                                                                                                                      Action
                                                                                                                                                      AnimationAPI
                                                                                                                                                      Data
                                                                                                                                                      draggable
                                                                                                                                                      System
                                                                                                                                                      TJSPositionTypes
                                                                                                                                                      TransformAPI
                                                                                                                                                      ValidatorAPI

                                                                                                                                                      Interfaces

                                                                                                                                                      AnimationAPI
                                                                                                                                                      AnimationGroupAPI
                                                                                                                                                      PositionStateAPI
                                                                                                                                                      TransformAPI
                                                                                                                                                      ValidatorAPI

                                                                                                                                                      Settings

                                                                                                                                                      Member Visibility

                                                                                                                                                      On This Page

                                                                                                                                                      Classes
                                                                                                                                                      Functions
                                                                                                                                                      Namespaces
                                                                                                                                                      Interfaces
                                                                                                                                                      \ 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 6b29b58..f8413f4 100644 --- a/docs/modules/_runtime_svelte_store_reducer.html +++ b/docs/modules/_runtime_svelte_store_reducer.html @@ -1,38 +1,2 @@ -#runtime/svelte/store/reducer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                      -

                                                                                                                                                        Package #runtime/svelte/store/reducer

                                                                                                                                                        - -

                                                                                                                                                        - Index -

                                                                                                                                                        -                                                                                                                                                         -
                                                                                                                                                        -

                                                                                                                                                        Classes

                                                                                                                                                        DynArrayReducer -DynArrayReducerDerived -DynMapReducer -DynMapReducerDerived -DynReducerHelper -

                                                                                                                                                        Interfaces

                                                                                                                                                        DynAdapterFilters -DynAdapterSort -DynArrayReducerCtor -DynDerivedAPI -DynDerivedReducer -DynDerivedReducerCtor -DynIndexerAPI -DynMapReducerCtor -

                                                                                                                                                        Type Aliases

                                                                                                                                                        DynArrayData -DynCompareFn -DynDataArrayCreate -DynDataDerivedCreate -DynDataFilter -DynDataHost -DynDataMapCreate -DynDataOptions -DynDataSort -DynFilterFn -DynIndexerUpdateFn -DynMapData -DynOptionsArrayCreate -DynOptionsDerivedCreate -DynOptionsMapCreate -
                                                                                                                                                        -

                                                                                                                                                        Settings

                                                                                                                                                        Member Visibility
                                                                                                                                                        \ No newline at end of file +#runtime/svelte/store/reducer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                        +

                                                                                                                                                          Package #runtime/svelte/store/reducer

                                                                                                                                                          Classes

                                                                                                                                                          DynArrayReducer
                                                                                                                                                          DynArrayReducerDerived
                                                                                                                                                          DynMapReducer
                                                                                                                                                          DynMapReducerDerived
                                                                                                                                                          DynReducerHelper

                                                                                                                                                          Interfaces

                                                                                                                                                          DynAdapterFilters
                                                                                                                                                          DynAdapterSort
                                                                                                                                                          DynArrayReducerCtor
                                                                                                                                                          DynDerivedAPI
                                                                                                                                                          DynDerivedReducer
                                                                                                                                                          DynDerivedReducerCtor
                                                                                                                                                          DynIndexerAPI
                                                                                                                                                          DynMapReducerCtor

                                                                                                                                                          Type Aliases

                                                                                                                                                          DynArrayData
                                                                                                                                                          DynCompareFn
                                                                                                                                                          DynDataArrayCreate
                                                                                                                                                          DynDataDerivedCreate
                                                                                                                                                          DynDataFilter
                                                                                                                                                          DynDataHost
                                                                                                                                                          DynDataMapCreate
                                                                                                                                                          DynDataOptions
                                                                                                                                                          DynDataSort
                                                                                                                                                          DynFilterFn
                                                                                                                                                          DynIndexerUpdateFn
                                                                                                                                                          DynMapData
                                                                                                                                                          DynOptionsArrayCreate
                                                                                                                                                          DynOptionsDerivedCreate
                                                                                                                                                          DynOptionsMapCreate

                                                                                                                                                          Settings

                                                                                                                                                          Member Visibility

                                                                                                                                                          On This Page

                                                                                                                                                          Classes
                                                                                                                                                          Interfaces
                                                                                                                                                          Type Aliases
                                                                                                                                                          \ 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 deleted file mode 100644 index d1ee6b5..0000000 --- a/docs/modules/_runtime_svelte_store_reducer_array_object.html +++ /dev/null @@ -1,19 +0,0 @@ -#runtime/svelte/store/reducer/array-object | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                          -

                                                                                                                                                            Package #runtime/svelte/store/reducer/array-object

                                                                                                                                                            - -

                                                                                                                                                            - Index -

                                                                                                                                                            -                                                                                                                                                             -
                                                                                                                                                            -

                                                                                                                                                            Classes

                                                                                                                                                            ArrayObjectStore -CrudArrayObjectStore -ObjectEntryStore -

                                                                                                                                                            Type Aliases

                                                                                                                                                            ArrayObjectStoreParams -ArrayObjectUpdateData -BaseArrayObjectEntryStore -CrudArrayObjectStoreParamProps -CrudArrayObjectStoreParams -CrudDispatch -
                                                                                                                                                            -

                                                                                                                                                            Settings

                                                                                                                                                            Member Visibility
                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_store_util.html b/docs/modules/_runtime_svelte_store_util.html index 874be06..49e2e50 100644 --- a/docs/modules/_runtime_svelte_store_util.html +++ b/docs/modules/_runtime_svelte_store_util.html @@ -1,16 +1,2 @@ -#runtime/svelte/store/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                            -

                                                                                                                                                              Package #runtime/svelte/store/util

                                                                                                                                                              - -

                                                                                                                                                              - Index -

                                                                                                                                                              -                                                                                                                                                               -
                                                                                                                                                              -

                                                                                                                                                              Functions

                                                                                                                                                              isMinimalWritableStore -isReadableStore -isWritableStore -subscribeFirstRest -subscribeIgnoreFirst -

                                                                                                                                                              Interfaces

                                                                                                                                                              MinimalWritable -
                                                                                                                                                              -

                                                                                                                                                              Settings

                                                                                                                                                              Member Visibility
                                                                                                                                                              \ No newline at end of file +#runtime/svelte/store/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                              +

                                                                                                                                                                Package #runtime/svelte/store/util

                                                                                                                                                                Functions

                                                                                                                                                                isMinimalWritableStore
                                                                                                                                                                isReadableStore
                                                                                                                                                                isWritableStore
                                                                                                                                                                subscribeFirstRest
                                                                                                                                                                subscribeIgnoreFirst

                                                                                                                                                                Interfaces

                                                                                                                                                                MinimalWritable

                                                                                                                                                                Settings

                                                                                                                                                                Member Visibility

                                                                                                                                                                On This Page

                                                                                                                                                                Functions
                                                                                                                                                                Interfaces
                                                                                                                                                                \ 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 deleted file mode 100644 index 2544e4e..0000000 --- a/docs/modules/_runtime_svelte_store_web_storage.html +++ /dev/null @@ -1,21 +0,0 @@ -#runtime/svelte/store/web-storage | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                -

                                                                                                                                                                  Package #runtime/svelte/store/web-storage

                                                                                                                                                                  - -

                                                                                                                                                                  - Index -

                                                                                                                                                                  -                                                                                                                                                                   -
                                                                                                                                                                  -

                                                                                                                                                                  Classes

                                                                                                                                                                  TJSLocalStorage -TJSSessionStorage -TJSWebStorage -

                                                                                                                                                                  Functions

                                                                                                                                                                  storeGenerator -

                                                                                                                                                                  Variables

                                                                                                                                                                  localStores -sessionStores -

                                                                                                                                                                  Interfaces

                                                                                                                                                                  WebStorage -

                                                                                                                                                                  Type Aliases

                                                                                                                                                                  StorageDerived -StorageReadable -StorageStores -StorageWritable -
                                                                                                                                                                  -

                                                                                                                                                                  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 deleted file mode 100644 index 3862d80..0000000 --- a/docs/modules/_runtime_svelte_store_web_storage_msgpack.html +++ /dev/null @@ -1,14 +0,0 @@ -#runtime/svelte/store/web-storage/msgpack | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                  -

                                                                                                                                                                    Package #runtime/svelte/store/web-storage/msgpack

                                                                                                                                                                    - -

                                                                                                                                                                    - Index -

                                                                                                                                                                    -                                                                                                                                                                     -
                                                                                                                                                                    -

                                                                                                                                                                    Classes

                                                                                                                                                                    TJSLocalStorageBCMP -TJSSessionStorageBCMP -

                                                                                                                                                                    Variables

                                                                                                                                                                    localStoresBCMP -sessionStoresBCMP -
                                                                                                                                                                    -

                                                                                                                                                                    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 deleted file mode 100644 index c1f9fe6..0000000 --- a/docs/modules/_runtime_svelte_store_writable_derived.html +++ /dev/null @@ -1,15 +0,0 @@ -#runtime/svelte/store/writable-derived | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                    -

                                                                                                                                                                      Package #runtime/svelte/store/writable-derived

                                                                                                                                                                      - -

                                                                                                                                                                      - Index -

                                                                                                                                                                      -                                                                                                                                                                       -
                                                                                                                                                                      -

                                                                                                                                                                      Functions

                                                                                                                                                                      propertyStore -writableDerived -

                                                                                                                                                                      Type Aliases

                                                                                                                                                                      SetValues -Stores -StoresValues -
                                                                                                                                                                      -

                                                                                                                                                                      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 3cdc8c6..05a0cce 100644 --- a/docs/modules/_runtime_svelte_transition.html +++ b/docs/modules/_runtime_svelte_transition.html @@ -1,15 +1,2 @@ -#runtime/svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                      -

                                                                                                                                                                        Package #runtime/svelte/transition

                                                                                                                                                                        - -

                                                                                                                                                                        - Index -

                                                                                                                                                                        -                                                                                                                                                                         -
                                                                                                                                                                        -

                                                                                                                                                                        Functions

                                                                                                                                                                        rotate -rotateFade -slideFade -toAnimation -

                                                                                                                                                                        Type Aliases

                                                                                                                                                                        TransitionFunction -
                                                                                                                                                                        -

                                                                                                                                                                        Settings

                                                                                                                                                                        Member Visibility
                                                                                                                                                                        \ No newline at end of file +#runtime/svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                        +

                                                                                                                                                                          Package #runtime/svelte/transition

                                                                                                                                                                          Functions

                                                                                                                                                                          rotate
                                                                                                                                                                          rotateFade
                                                                                                                                                                          slideFade
                                                                                                                                                                          toAnimation

                                                                                                                                                                          Type Aliases

                                                                                                                                                                          TransitionFunction

                                                                                                                                                                          Settings

                                                                                                                                                                          Member Visibility

                                                                                                                                                                          On This Page

                                                                                                                                                                          Functions
                                                                                                                                                                          Type Aliases
                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_svelte_util.html b/docs/modules/_runtime_svelte_util.html index 6b9be6e..c2f4308 100644 --- a/docs/modules/_runtime_svelte_util.html +++ b/docs/modules/_runtime_svelte_util.html @@ -1,13 +1,2 @@ -#runtime/svelte/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                          -

                                                                                                                                                                            Package #runtime/svelte/util

                                                                                                                                                                            - -

                                                                                                                                                                            - Index -

                                                                                                                                                                            -                                                                                                                                                                             -
                                                                                                                                                                            -

                                                                                                                                                                            Classes

                                                                                                                                                                            TJSSvelteConfigUtil -TJSSvelteUtil -

                                                                                                                                                                            Type Aliases

                                                                                                                                                                            TJSSvelteConfig -
                                                                                                                                                                            -

                                                                                                                                                                            Settings

                                                                                                                                                                            Member Visibility
                                                                                                                                                                            \ No newline at end of file +#runtime/svelte/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                            +

                                                                                                                                                                              Package #runtime/svelte/util

                                                                                                                                                                              Classes

                                                                                                                                                                              TJSSvelteConfigUtil
                                                                                                                                                                              TJSSvelteUtil

                                                                                                                                                                              Type Aliases

                                                                                                                                                                              TJSSvelteConfig

                                                                                                                                                                              Settings

                                                                                                                                                                              Member Visibility

                                                                                                                                                                              On This Page

                                                                                                                                                                              Classes
                                                                                                                                                                              Type Aliases
                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_util.html b/docs/modules/_runtime_util.html index bdb147c..f196685 100644 --- a/docs/modules/_runtime_util.html +++ b/docs/modules/_runtime_util.html @@ -1,13 +1,2 @@ -#runtime/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                              -

                                                                                                                                                                                Package #runtime/util

                                                                                                                                                                                - -

                                                                                                                                                                                - Index -

                                                                                                                                                                                -                                                                                                                                                                                 -
                                                                                                                                                                                -

                                                                                                                                                                                Classes

                                                                                                                                                                                Hashing -Strings -Timing -
                                                                                                                                                                                -

                                                                                                                                                                                Settings

                                                                                                                                                                                Member Visibility
                                                                                                                                                                                \ No newline at end of file +#runtime/util | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                +

                                                                                                                                                                                  Package #runtime/util

                                                                                                                                                                                  Classes

                                                                                                                                                                                  Hashing
                                                                                                                                                                                  Strings
                                                                                                                                                                                  Timing

                                                                                                                                                                                  Settings

                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                  On This Page

                                                                                                                                                                                  Classes
                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_util_a11y.html b/docs/modules/_runtime_util_a11y.html index 0a8b45e..18cdda7 100644 --- a/docs/modules/_runtime_util_a11y.html +++ b/docs/modules/_runtime_util_a11y.html @@ -1,14 +1,2 @@ -#runtime/util/a11y | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                  -

                                                                                                                                                                                    Package #runtime/util/a11y

                                                                                                                                                                                    - -

                                                                                                                                                                                    - Index -

                                                                                                                                                                                    -                                                                                                                                                                                     -
                                                                                                                                                                                    -

                                                                                                                                                                                    Classes

                                                                                                                                                                                    A11yHelper -

                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                    A11yFocusSource -FocusableElement -FocusableElementOptions -
                                                                                                                                                                                    -

                                                                                                                                                                                    Settings

                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                    \ No newline at end of file +#runtime/util/a11y | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                    +

                                                                                                                                                                                      Package #runtime/util/a11y

                                                                                                                                                                                      Classes

                                                                                                                                                                                      A11yHelper

                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                      A11yFocusSource
                                                                                                                                                                                      FocusableElement
                                                                                                                                                                                      FocusableElementOptions

                                                                                                                                                                                      Settings

                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                      On This Page

                                                                                                                                                                                      Classes
                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_runtime_util_animate.html b/docs/modules/_runtime_util_animate.html index ce37164..7fe6ec5 100644 --- a/docs/modules/_runtime_util_animate.html +++ b/docs/modules/_runtime_util_animate.html @@ -1,13 +1,2 @@ -#runtime/util/animate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                      -

                                                                                                                                                                                        Package #runtime/util/animate

                                                                                                                                                                                        - -

                                                                                                                                                                                        - Index -

                                                                                                                                                                                        -                                                                                                                                                                                         -
                                                                                                                                                                                        -

                                                                                                                                                                                        Functions

                                                                                                                                                                                        nextAnimationFrame -

                                                                                                                                                                                        Interfaces

                                                                                                                                                                                        BasicAnimation -

                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                        BasicAnimationState -
                                                                                                                                                                                        -

                                                                                                                                                                                        Settings

                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                        \ No newline at end of file +#runtime/util/animate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                        +

                                                                                                                                                                                          Package #runtime/util/animate

                                                                                                                                                                                          Functions

                                                                                                                                                                                          nextAnimationFrame

                                                                                                                                                                                          Interfaces

                                                                                                                                                                                          BasicAnimation

                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                          BasicAnimationState

                                                                                                                                                                                          Settings

                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                          On This Page

                                                                                                                                                                                          Functions
                                                                                                                                                                                          Interfaces
                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_util_async.html b/docs/modules/_runtime_util_async.html index 8449fd2..838d48d 100644 --- a/docs/modules/_runtime_util_async.html +++ b/docs/modules/_runtime_util_async.html @@ -1,12 +1,2 @@ -#runtime/util/async | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                          -

                                                                                                                                                                                            Package #runtime/util/async

                                                                                                                                                                                            - -

                                                                                                                                                                                            - Index -

                                                                                                                                                                                            -                                                                                                                                                                                             -
                                                                                                                                                                                            -

                                                                                                                                                                                            Classes

                                                                                                                                                                                            ImageData -ManagedPromise -
                                                                                                                                                                                            -

                                                                                                                                                                                            Settings

                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                            \ No newline at end of file +#runtime/util/async | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                            +

                                                                                                                                                                                              Package #runtime/util/async

                                                                                                                                                                                              Classes

                                                                                                                                                                                              ImageData
                                                                                                                                                                                              ManagedPromise

                                                                                                                                                                                              Settings

                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                              On This Page

                                                                                                                                                                                              Classes
                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_util_browser.html b/docs/modules/_runtime_util_browser.html index d9ef069..94f24aa 100644 --- a/docs/modules/_runtime_util_browser.html +++ b/docs/modules/_runtime_util_browser.html @@ -1,14 +1,2 @@ -#runtime/util/browser | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                              -

                                                                                                                                                                                                Package #runtime/util/browser

                                                                                                                                                                                                - -

                                                                                                                                                                                                - Index -

                                                                                                                                                                                                -                                                                                                                                                                                                 -
                                                                                                                                                                                                -

                                                                                                                                                                                                Classes

                                                                                                                                                                                                BrowserSupports -ClipboardAccess -CrossWindow -URLParser -
                                                                                                                                                                                                -

                                                                                                                                                                                                Settings

                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                \ No newline at end of file +#runtime/util/browser | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                +

                                                                                                                                                                                                  Package #runtime/util/browser

                                                                                                                                                                                                  Classes

                                                                                                                                                                                                  BrowserSupports
                                                                                                                                                                                                  ClipboardAccess
                                                                                                                                                                                                  CrossWindow
                                                                                                                                                                                                  URLParser

                                                                                                                                                                                                  Settings

                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                  Classes
                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_util_dom_input_tinykeys.html b/docs/modules/_runtime_util_dom_input_tinykeys.html index d3ab70a..13324d3 100644 --- a/docs/modules/_runtime_util_dom_input_tinykeys.html +++ b/docs/modules/_runtime_util_dom_input_tinykeys.html @@ -1,22 +1,6 @@ -#runtime/util/dom/input/tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                  -

                                                                                                                                                                                                    Package #runtime/util/dom/input/tinykeys

                                                                                                                                                                                                    A tiny (~650 B) & modern library for keybindings.

                                                                                                                                                                                                    +#runtime/util/dom/input/tinykeys | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                    +

                                                                                                                                                                                                      Package #runtime/util/dom/input/tinykeys

                                                                                                                                                                                                      A tiny (~650 B) & modern library for keybindings.

                                                                                                                                                                                                      Super handy as tinykeys returns an unsubscribe function which makes it easy to integrate with Svelte actions or otherwise.

                                                                                                                                                                                                      -

                                                                                                                                                                                                      See

                                                                                                                                                                                                      https://www.npmjs.com/package/tinykeys

                                                                                                                                                                                                      -
                                                                                                                                                                                                      - -

                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                      -                                                                                                                                                                                                       -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Functions

                                                                                                                                                                                                      createKeybindingsHandler -matchKeyBindingPress -parseKeybinding -tinykeys -

                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                      KeyBindingHandlerOptions -KeyBindingMap -KeyBindingOptions -

                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                      KeyBindingPress -
                                                                                                                                                                                                      -

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                      See

                                                                                                                                                                                                      https://www.npmjs.com/package/tinykeys

                                                                                                                                                                                                      +

                                                                                                                                                                                                      Functions

                                                                                                                                                                                                      createKeybindingsHandler
                                                                                                                                                                                                      matchKeyBindingPress
                                                                                                                                                                                                      parseKeybinding
                                                                                                                                                                                                      tinykeys

                                                                                                                                                                                                      Interfaces

                                                                                                                                                                                                      KeyBindingHandlerOptions
                                                                                                                                                                                                      KeyBindingMap
                                                                                                                                                                                                      KeyBindingOptions

                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                      KeyBindingPress

                                                                                                                                                                                                      Settings

                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                      Functions
                                                                                                                                                                                                      Interfaces
                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_runtime_util_dom_layout.html b/docs/modules/_runtime_util_dom_layout.html index 1674f58..7b1f45c 100644 --- a/docs/modules/_runtime_util_dom_layout.html +++ b/docs/modules/_runtime_util_dom_layout.html @@ -1,12 +1,2 @@ -#runtime/util/dom/layout | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                      -

                                                                                                                                                                                                        Package #runtime/util/dom/layout

                                                                                                                                                                                                        - -

                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                        -                                                                                                                                                                                                         -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Functions

                                                                                                                                                                                                        getStackingContext -

                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                        StackingContext -
                                                                                                                                                                                                        -

                                                                                                                                                                                                        Settings

                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                        \ No newline at end of file +#runtime/util/dom/layout | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                        +

                                                                                                                                                                                                          Package #runtime/util/dom/layout

                                                                                                                                                                                                          Functions

                                                                                                                                                                                                          getStackingContext

                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                          StackingContext

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Functions
                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_util_dom_observer.ResizeObserverData.html b/docs/modules/_runtime_util_dom_observer.ResizeObserverData.html index eae39a4..141ea6a 100644 --- a/docs/modules/_runtime_util_dom_observer.ResizeObserverData.html +++ b/docs/modules/_runtime_util_dom_observer.ResizeObserverData.html @@ -1,15 +1,3 @@ -ResizeObserverData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Namespace ResizeObserverData

                                                                                                                                                                                                          Provides various type aliases used by ResizeObserverManager.

                                                                                                                                                                                                          -
                                                                                                                                                                                                          - -

                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                          -                                                                                                                                                                                                           -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                          ResizeFunction -ResizeObject -ResizeObjectExtended -ResizeTarget -
                                                                                                                                                                                                          -

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                          \ No newline at end of file +ResizeObserverData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                          +

                                                                                                                                                                                                          Namespace ResizeObserverData

                                                                                                                                                                                                          Provides various type aliases used by ResizeObserverManager.

                                                                                                                                                                                                          +

                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                          ResizeFunction
                                                                                                                                                                                                          ResizeObject
                                                                                                                                                                                                          ResizeObjectExtended
                                                                                                                                                                                                          ResizeTarget

                                                                                                                                                                                                          Settings

                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_util_dom_observer.html b/docs/modules/_runtime_util_dom_observer.html index 5eebe3b..fb69cea 100644 --- a/docs/modules/_runtime_util_dom_observer.html +++ b/docs/modules/_runtime_util_dom_observer.html @@ -1,12 +1,2 @@ -#runtime/util/dom/observer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                          -

                                                                                                                                                                                                            Package #runtime/util/dom/observer

                                                                                                                                                                                                            - -

                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                            -                                                                                                                                                                                                             -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Classes

                                                                                                                                                                                                            ResizeObserverManager -

                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                            ResizeObserverData -
                                                                                                                                                                                                            -

                                                                                                                                                                                                            Settings

                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                            \ No newline at end of file +#runtime/util/dom/observer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                            +

                                                                                                                                                                                                              Package #runtime/util/dom/observer

                                                                                                                                                                                                              Classes

                                                                                                                                                                                                              ResizeObserverManager

                                                                                                                                                                                                              Namespaces

                                                                                                                                                                                                              ResizeObserverData

                                                                                                                                                                                                              Settings

                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                              Classes
                                                                                                                                                                                                              Namespaces
                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_util_dom_style.html b/docs/modules/_runtime_util_dom_style.html index b546391..26af5d5 100644 --- a/docs/modules/_runtime_util_dom_style.html +++ b/docs/modules/_runtime_util_dom_style.html @@ -1,12 +1,2 @@ -#runtime/util/dom/style | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                              -

                                                                                                                                                                                                                Package #runtime/util/dom/style

                                                                                                                                                                                                                - -

                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                -                                                                                                                                                                                                                 -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                StyleParse -TJSStyleManager -
                                                                                                                                                                                                                -

                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                \ No newline at end of file +#runtime/util/dom/style | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                +

                                                                                                                                                                                                                  Package #runtime/util/dom/style

                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                  StyleParse
                                                                                                                                                                                                                  TJSStyleManager

                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                  Classes
                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_runtime_util_html.html b/docs/modules/_runtime_util_html.html index 4804771..3ac42f4 100644 --- a/docs/modules/_runtime_util_html.html +++ b/docs/modules/_runtime_util_html.html @@ -1,11 +1,2 @@ -#runtime/util/html | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                  -

                                                                                                                                                                                                                    Package #runtime/util/html

                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                    -                                                                                                                                                                                                                     -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Functions

                                                                                                                                                                                                                    processHTML -
                                                                                                                                                                                                                    -

                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                    \ No newline at end of file +#runtime/util/html | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                    +

                                                                                                                                                                                                                      Package #runtime/util/html

                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                      processHTML

                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                      Functions
                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_runtime_util_html_striptags.html b/docs/modules/_runtime_util_html_striptags.html index 47dde2d..c676cf6 100644 --- a/docs/modules/_runtime_util_html_striptags.html +++ b/docs/modules/_runtime_util_html_striptags.html @@ -1,14 +1,2 @@ -#runtime/util/html/striptags | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                      -

                                                                                                                                                                                                                        Package #runtime/util/html/striptags

                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                        -                                                                                                                                                                                                                         -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                        StateMachine -

                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                        striptags -

                                                                                                                                                                                                                        Variables

                                                                                                                                                                                                                        DefaultStateMachineOptions -

                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                        StateMachineOptions -
                                                                                                                                                                                                                        -

                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                        \ No newline at end of file +#runtime/util/html/striptags | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                        +

                                                                                                                                                                                                                          Package #runtime/util/html/striptags

                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                          StateMachine

                                                                                                                                                                                                                          Functions

                                                                                                                                                                                                                          striptags

                                                                                                                                                                                                                          Variables

                                                                                                                                                                                                                          DefaultStateMachineOptions

                                                                                                                                                                                                                          Interfaces

                                                                                                                                                                                                                          StateMachineOptions

                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                          Functions
                                                                                                                                                                                                                          Variables
                                                                                                                                                                                                                          Interfaces
                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_runtime_util_i18n.html b/docs/modules/_runtime_util_i18n.html index 831e3fa..91a17f4 100644 --- a/docs/modules/_runtime_util_i18n.html +++ b/docs/modules/_runtime_util_i18n.html @@ -1,11 +1,2 @@ -#runtime/util/i18n | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                          -

                                                                                                                                                                                                                            Package #runtime/util/i18n

                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                            -                                                                                                                                                                                                                             -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                            localize -
                                                                                                                                                                                                                            -

                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                            \ No newline at end of file +#runtime/util/i18n | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                            +

                                                                                                                                                                                                                              Package #runtime/util/i18n

                                                                                                                                                                                                                              Functions

                                                                                                                                                                                                                              localize

                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                              Functions
                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_runtime_util_loader_module.html b/docs/modules/_runtime_util_loader_module.html deleted file mode 100644 index 3db026b..0000000 --- a/docs/modules/_runtime_util_loader_module.html +++ /dev/null @@ -1,13 +0,0 @@ -#runtime/util/loader-module | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                Package #runtime/util/loader-module

                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                                -                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                ModuleLoader -ModuleLoadError -

                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                ModuleLoaderObj -
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                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 19714a8..d5dbc78 100644 --- a/docs/modules/_runtime_util_object.html +++ b/docs/modules/_runtime_util_object.html @@ -1,40 +1,2 @@ -#runtime/util/object | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                  Package #runtime/util/object

                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Functions

                                                                                                                                                                                                                                  deepFreeze -deepMerge -depthTraverse -getAccessorList -hasAccessor -hasGetter -hasPrototype -hasSetter -isAsyncIterable -isIterable -isObject -isPlainObject -klona -objectKeys -objectSize -safeAccess -safeBatchSet -safeEqual -safeSet -safeSetAll -validate -validateArray -validateEntry -validateEntryOrArray -

                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                  JSONArray -JSONObject -

                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                  JSONValue -Primitive -SafeSetOperation -ValidationEntry -
                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                  \ No newline at end of file +#runtime/util/object | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                    Package #runtime/util/object

                                                                                                                                                                                                                                    Functions

                                                                                                                                                                                                                                    deepFreeze
                                                                                                                                                                                                                                    deepMerge
                                                                                                                                                                                                                                    depthTraverse
                                                                                                                                                                                                                                    getAccessorList
                                                                                                                                                                                                                                    hasAccessor
                                                                                                                                                                                                                                    hasGetter
                                                                                                                                                                                                                                    hasPrototype
                                                                                                                                                                                                                                    hasSetter
                                                                                                                                                                                                                                    isAsyncIterable
                                                                                                                                                                                                                                    isIterable
                                                                                                                                                                                                                                    isObject
                                                                                                                                                                                                                                    isPlainObject
                                                                                                                                                                                                                                    klona
                                                                                                                                                                                                                                    objectKeys
                                                                                                                                                                                                                                    objectSize
                                                                                                                                                                                                                                    safeAccess
                                                                                                                                                                                                                                    safeBatchSet
                                                                                                                                                                                                                                    safeEqual
                                                                                                                                                                                                                                    safeSet
                                                                                                                                                                                                                                    safeSetAll
                                                                                                                                                                                                                                    validate
                                                                                                                                                                                                                                    validateArray
                                                                                                                                                                                                                                    validateEntry
                                                                                                                                                                                                                                    validateEntryOrArray

                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                    JSONArray
                                                                                                                                                                                                                                    JSONObject

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    JSONValue
                                                                                                                                                                                                                                    Primitive
                                                                                                                                                                                                                                    SafeSetOperation
                                                                                                                                                                                                                                    ValidationEntry

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Functions
                                                                                                                                                                                                                                    Interfaces
                                                                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_action_animate_composable.ComposableActionOptions.html b/docs/modules/_standard_action_animate_composable.ComposableActionOptions.html index 5db1a95..17cb232 100644 --- a/docs/modules/_standard_action_animate_composable.ComposableActionOptions.html +++ b/docs/modules/_standard_action_animate_composable.ComposableActionOptions.html @@ -1,14 +1,3 @@ -ComposableActionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Namespace ComposableActionOptions

                                                                                                                                                                                                                                    Defines the options for all composable animation actions.

                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    AnimateWAAPI -Ripple -RippleFocus -
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                    \ No newline at end of file +ComposableActionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Namespace ComposableActionOptions

                                                                                                                                                                                                                                    Defines the options for all composable animation actions.

                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                    AnimateWAAPI
                                                                                                                                                                                                                                    Ripple
                                                                                                                                                                                                                                    RippleFocus

                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_action_animate_composable.html b/docs/modules/_standard_action_animate_composable.html index b4c928d..37b51f4 100644 --- a/docs/modules/_standard_action_animate_composable.html +++ b/docs/modules/_standard_action_animate_composable.html @@ -1,15 +1,2 @@ -#standard/action/animate/composable | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                      Package #standard/action/animate/composable

                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Functions

                                                                                                                                                                                                                                      animateWAAPI -composable -ripple -rippleFocus -

                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                      ComposableActionOptions -
                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                      \ No newline at end of file +#standard/action/animate/composable | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                        Package #standard/action/animate/composable

                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                        animateWAAPI
                                                                                                                                                                                                                                        composable
                                                                                                                                                                                                                                        ripple
                                                                                                                                                                                                                                        rippleFocus

                                                                                                                                                                                                                                        Namespaces

                                                                                                                                                                                                                                        ComposableActionOptions

                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                        Functions
                                                                                                                                                                                                                                        Namespaces
                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_application_control_filepicker.html b/docs/modules/_standard_application_control_filepicker.html index abfa8d0..b50010a 100644 --- a/docs/modules/_standard_application_control_filepicker.html +++ b/docs/modules/_standard_application_control_filepicker.html @@ -1,12 +1,2 @@ -#standard/application/control/filepicker | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                          Package #standard/application/control/filepicker

                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                          FVTTFilePickerControl -

                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                          FVTTFilePickerBrowseOptions -
                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                          \ No newline at end of file +#standard/application/control/filepicker | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                            Package #standard/application/control/filepicker

                                                                                                                                                                                                                                            Classes

                                                                                                                                                                                                                                            FVTTFilePickerControl

                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                            FVTTFilePickerBrowseOptions

                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                            Classes
                                                                                                                                                                                                                                            Type Aliases
                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_application_control_sidebar.html b/docs/modules/_standard_application_control_sidebar.html index 575a37d..674a61b 100644 --- a/docs/modules/_standard_application_control_sidebar.html +++ b/docs/modules/_standard_application_control_sidebar.html @@ -1,15 +1,2 @@ -#standard/application/control/sidebar | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                              Package #standard/application/control/sidebar

                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                              FVTTSidebarControl -

                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                              FVTTSidebarAddData -FVTTSidebarEntry -FVTTSidebarRemoveData -FVTTSidebarReplaceData -
                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                              \ No newline at end of file +#standard/application/control/sidebar | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                Package #standard/application/control/sidebar

                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                FVTTSidebarControl

                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                FVTTSidebarAddData
                                                                                                                                                                                                                                                FVTTSidebarEntry
                                                                                                                                                                                                                                                FVTTSidebarRemoveData
                                                                                                                                                                                                                                                FVTTSidebarReplaceData

                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                                                Type Aliases
                                                                                                                                                                                                                                                \ 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 aca6846..24fc7c3 100644 --- a/docs/modules/_standard_application_dialog_document.html +++ b/docs/modules/_standard_application_dialog_document.html @@ -1,20 +1,2 @@ -#standard/application/dialog/document | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                  Package #standard/application/dialog/document

                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                  TJSDocumentCreate -TJSDocumentDelete -TJSDocumentDialog -TJSDocumentImport -TJSDocumentOwnership -TJSFolderCreateUpdate -TJSFolderDelete -TJSFolderExport -TJSFolderRemove -TJSFolderRolltable -
                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                  \ No newline at end of file +#standard/application/dialog/document | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                    Package #standard/application/dialog/document

                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                    TJSDocumentCreate
                                                                                                                                                                                                                                                    TJSDocumentDelete
                                                                                                                                                                                                                                                    TJSDocumentDialog
                                                                                                                                                                                                                                                    TJSDocumentImport
                                                                                                                                                                                                                                                    TJSDocumentOwnership
                                                                                                                                                                                                                                                    TJSFolderCreateUpdate
                                                                                                                                                                                                                                                    TJSFolderDelete
                                                                                                                                                                                                                                                    TJSFolderExport
                                                                                                                                                                                                                                                    TJSFolderRemove
                                                                                                                                                                                                                                                    TJSFolderRolltable

                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                    Classes
                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_application_menu.html b/docs/modules/_standard_application_menu.html index 7ef4929..6b36cce 100644 --- a/docs/modules/_standard_application_menu.html +++ b/docs/modules/_standard_application_menu.html @@ -1,12 +1,2 @@ -#standard/application/menu | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                      Package #standard/application/menu

                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                      TJSContextMenu -

                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                      TJSContextMenuItemData -
                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                      \ No newline at end of file +#standard/application/menu | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                        Package #standard/application/menu

                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                        TJSContextMenu

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        TJSContextMenuItemData

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Classes
                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_button.TJSIconButton-1.html b/docs/modules/_standard_component_button.TJSIconButton-1.html index b67608a..42dda81 100644 --- a/docs/modules/_standard_component_button.TJSIconButton-1.html +++ b/docs/modules/_standard_component_button.TJSIconButton-1.html @@ -1,14 +1,3 @@ -TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Namespace TJSIconButton

                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        Events -Props -Slots -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        \ No newline at end of file +TJSIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Namespace TJSIconButton

                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        Events
                                                                                                                                                                                                                                                        Props
                                                                                                                                                                                                                                                        Slots

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_button.TJSSlotButton-1.html b/docs/modules/_standard_component_button.TJSSlotButton-1.html index 4b0b8ba..51a492f 100644 --- a/docs/modules/_standard_component_button.TJSSlotButton-1.html +++ b/docs/modules/_standard_component_button.TJSSlotButton-1.html @@ -1,14 +1,3 @@ -TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Namespace TJSSlotButton

                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        Events -Props -Slots -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        \ No newline at end of file +TJSSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Namespace TJSSlotButton

                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        Events
                                                                                                                                                                                                                                                        Props
                                                                                                                                                                                                                                                        Slots

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_button.TJSToggleIconButton-1.html b/docs/modules/_standard_component_button.TJSToggleIconButton-1.html index e534f89..8ac781d 100644 --- a/docs/modules/_standard_component_button.TJSToggleIconButton-1.html +++ b/docs/modules/_standard_component_button.TJSToggleIconButton-1.html @@ -1,14 +1,3 @@ -TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Namespace TJSToggleIconButton

                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        Events -Props -Slots -
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                        \ No newline at end of file +TJSToggleIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Namespace TJSToggleIconButton

                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                        Events
                                                                                                                                                                                                                                                        Props
                                                                                                                                                                                                                                                        Slots

                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_button.html b/docs/modules/_standard_component_button.html index 7aa5cfe..05c01b1 100644 --- a/docs/modules/_standard_component_button.html +++ b/docs/modules/_standard_component_button.html @@ -1,16 +1,2 @@ -#standard/component/button | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                          Package #standard/component/button

                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                          TJSIconButton -TJSSlotButton -TJSToggleIconButton -

                                                                                                                                                                                                                                                          Namespaces

                                                                                                                                                                                                                                                          TJSIconButton -TJSSlotButton -TJSToggleIconButton -
                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                          \ No newline at end of file +#standard/component/button | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                            Package #standard/component/button

                                                                                                                                                                                                                                                            Classes

                                                                                                                                                                                                                                                            TJSIconButton
                                                                                                                                                                                                                                                            TJSSlotButton
                                                                                                                                                                                                                                                            TJSToggleIconButton

                                                                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                                                                            TJSIconButton
                                                                                                                                                                                                                                                            TJSSlotButton
                                                                                                                                                                                                                                                            TJSToggleIconButton

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                            Classes
                                                                                                                                                                                                                                                            Namespaces
                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_component_color_picker_colord.TJSColordButton-1.html b/docs/modules/_standard_component_color_picker_colord.TJSColordButton-1.html deleted file mode 100644 index b44cf30..0000000 --- a/docs/modules/_standard_component_color_picker_colord.TJSColordButton-1.html +++ /dev/null @@ -1,14 +0,0 @@ -TJSColordButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Namespace TJSColordButton

                                                                                                                                                                                                                                                            Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                            Events -Props -Slots -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_component_color_picker_colord.TJSColordPicker-1.html b/docs/modules/_standard_component_color_picker_colord.TJSColordPicker-1.html deleted file mode 100644 index 2c142d6..0000000 --- a/docs/modules/_standard_component_color_picker_colord.TJSColordPicker-1.html +++ /dev/null @@ -1,14 +0,0 @@ -TJSColordPicker | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Namespace TJSColordPicker

                                                                                                                                                                                                                                                            Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                            Events -Props -Slots -
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_component_color_picker_colord.html b/docs/modules/_standard_component_color_picker_colord.html deleted file mode 100644 index 9eb7da8..0000000 --- a/docs/modules/_standard_component_color_picker_colord.html +++ /dev/null @@ -1,18 +0,0 @@ -#standard/component/color/picker-colord | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                              Package #standard/component/color/picker-colord

                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                              TJSColordButton -TJSColordPicker -TJSColordPickerSavedColors -

                                                                                                                                                                                                                                                              Namespaces

                                                                                                                                                                                                                                                              TJSColordButton -TJSColordPicker -

                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                              TJSColordPickerColor -TJSColordPickerComponents -TJSColordPickerOptions -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_container.TJSScrollContainer-1.html b/docs/modules/_standard_component_container.TJSScrollContainer-1.html index 7876c5b..baf822c 100644 --- a/docs/modules/_standard_component_container.TJSScrollContainer-1.html +++ b/docs/modules/_standard_component_container.TJSScrollContainer-1.html @@ -1,14 +1,3 @@ -TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Namespace TJSScrollContainer

                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                              Events -Props -Slots -
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                              \ No newline at end of file +TJSScrollContainer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Namespace TJSScrollContainer

                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                              Events
                                                                                                                                                                                                                                                              Props
                                                                                                                                                                                                                                                              Slots

                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                              Type Aliases
                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_container.html b/docs/modules/_standard_component_container.html index 18eda10..4534a48 100644 --- a/docs/modules/_standard_component_container.html +++ b/docs/modules/_standard_component_container.html @@ -1,13 +1,2 @@ -#standard/component/container | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                Package #standard/component/container

                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                TJSScrollContainer -

                                                                                                                                                                                                                                                                Namespaces

                                                                                                                                                                                                                                                                TJSScrollContainer -

                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                TJSScrollContainerData -
                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                \ No newline at end of file +#standard/component/container | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                  Package #standard/component/container

                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                  TJSScrollContainer

                                                                                                                                                                                                                                                                  Namespaces

                                                                                                                                                                                                                                                                  TJSScrollContainer

                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                  TJSScrollContainerData

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Classes
                                                                                                                                                                                                                                                                  Namespaces
                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_dom_focus.TJSFocusWrap-1.html b/docs/modules/_standard_component_dom_focus.TJSFocusWrap-1.html index 4252979..8585793 100644 --- a/docs/modules/_standard_component_dom_focus.TJSFocusWrap-1.html +++ b/docs/modules/_standard_component_dom_focus.TJSFocusWrap-1.html @@ -1,14 +1,3 @@ -TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Namespace TJSFocusWrap

                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                  Events -Props -Slots -
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                  \ No newline at end of file +TJSFocusWrap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Namespace TJSFocusWrap

                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                  Events
                                                                                                                                                                                                                                                                  Props
                                                                                                                                                                                                                                                                  Slots

                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_dom_focus.html b/docs/modules/_standard_component_dom_focus.html index 24ba3ad..352b9e7 100644 --- a/docs/modules/_standard_component_dom_focus.html +++ b/docs/modules/_standard_component_dom_focus.html @@ -1,12 +1,2 @@ -#standard/component/dom/focus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                    Package #standard/component/dom/focus

                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                    TJSFocusWrap -

                                                                                                                                                                                                                                                                    Namespaces

                                                                                                                                                                                                                                                                    TJSFocusWrap -
                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                    \ No newline at end of file +#standard/component/dom/focus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                      Package #standard/component/dom/focus

                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                      TJSFocusWrap

                                                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                                                      TJSFocusWrap

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                      Namespaces
                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_folder.TJSIconFolder-1.html b/docs/modules/_standard_component_folder.TJSIconFolder-1.html index 314b5a5..ac803e6 100644 --- a/docs/modules/_standard_component_folder.TJSIconFolder-1.html +++ b/docs/modules/_standard_component_folder.TJSIconFolder-1.html @@ -1,14 +1,3 @@ -TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Namespace TJSIconFolder

                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                      Events -Props -Slots -
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSIconFolder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Namespace TJSIconFolder

                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                      Events
                                                                                                                                                                                                                                                                      Props
                                                                                                                                                                                                                                                                      Slots

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_folder.TJSSvgFolder-1.html b/docs/modules/_standard_component_folder.TJSSvgFolder-1.html index ee381bc..8cc11da 100644 --- a/docs/modules/_standard_component_folder.TJSSvgFolder-1.html +++ b/docs/modules/_standard_component_folder.TJSSvgFolder-1.html @@ -1,14 +1,3 @@ -TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Namespace TJSSvgFolder

                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                      Events -Props -Slots -
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSSvgFolder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Namespace TJSSvgFolder

                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                      Events
                                                                                                                                                                                                                                                                      Props
                                                                                                                                                                                                                                                                      Slots

                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_folder.html b/docs/modules/_standard_component_folder.html index b11f433..cff5b29 100644 --- a/docs/modules/_standard_component_folder.html +++ b/docs/modules/_standard_component_folder.html @@ -1,17 +1,2 @@ -#standard/component/folder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                        Package #standard/component/folder

                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                        TJSIconFolder -TJSSvgFolder -

                                                                                                                                                                                                                                                                        Namespaces

                                                                                                                                                                                                                                                                        TJSIconFolder -TJSSvgFolder -

                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                        TJSFolderData -TJSFolderOptions -TJSIconFolderData -
                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                        \ No newline at end of file +#standard/component/folder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                          Package #standard/component/folder

                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                          TJSIconFolder
                                                                                                                                                                                                                                                                          TJSSvgFolder

                                                                                                                                                                                                                                                                          Namespaces

                                                                                                                                                                                                                                                                          TJSIconFolder
                                                                                                                                                                                                                                                                          TJSSvgFolder

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          TJSFolderData
                                                                                                                                                                                                                                                                          TJSFolderOptions
                                                                                                                                                                                                                                                                          TJSIconFolderData

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                                                                          Namespaces
                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSButton-1.html b/docs/modules/_standard_component_form.TJSButton-1.html index 5ea181c..0dd4e5f 100644 --- a/docs/modules/_standard_component_form.TJSButton-1.html +++ b/docs/modules/_standard_component_form.TJSButton-1.html @@ -1,14 +1,3 @@ -TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSButton

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSButton

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSInput-1.html b/docs/modules/_standard_component_form.TJSInput-1.html index 405321c..0d7e1d0 100644 --- a/docs/modules/_standard_component_form.TJSInput-1.html +++ b/docs/modules/_standard_component_form.TJSInput-1.html @@ -1,14 +1,3 @@ -TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSInput

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSInput | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSInput

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSInputCheckbox-1.html b/docs/modules/_standard_component_form.TJSInputCheckbox-1.html index b6b00e6..9edc135 100644 --- a/docs/modules/_standard_component_form.TJSInputCheckbox-1.html +++ b/docs/modules/_standard_component_form.TJSInputCheckbox-1.html @@ -1,14 +1,3 @@ -TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSInputCheckbox

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSInputCheckbox | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSInputCheckbox

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSInputNumber-1.html b/docs/modules/_standard_component_form.TJSInputNumber-1.html index efbba83..f0eebe5 100644 --- a/docs/modules/_standard_component_form.TJSInputNumber-1.html +++ b/docs/modules/_standard_component_form.TJSInputNumber-1.html @@ -1,14 +1,3 @@ -TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSInputNumber

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSInputNumber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSInputNumber

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSInputRange-1.html b/docs/modules/_standard_component_form.TJSInputRange-1.html index b48d8d3..9fd386b 100644 --- a/docs/modules/_standard_component_form.TJSInputRange-1.html +++ b/docs/modules/_standard_component_form.TJSInputRange-1.html @@ -1,14 +1,3 @@ -TJSInputRange | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSInputRange

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSInputRange | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSInputRange

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSInputRangeNumber-1.html b/docs/modules/_standard_component_form.TJSInputRangeNumber-1.html index 1073a0b..b740130 100644 --- a/docs/modules/_standard_component_form.TJSInputRangeNumber-1.html +++ b/docs/modules/_standard_component_form.TJSInputRangeNumber-1.html @@ -1,14 +1,3 @@ -TJSInputRangeNumber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSInputRangeNumber

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSInputRangeNumber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSInputRangeNumber

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSInputText-1.html b/docs/modules/_standard_component_form.TJSInputText-1.html index 3194de1..936eb32 100644 --- a/docs/modules/_standard_component_form.TJSInputText-1.html +++ b/docs/modules/_standard_component_form.TJSInputText-1.html @@ -1,14 +1,3 @@ -TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSInputText

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSInputText | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSInputText

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.TJSSelect-1.html b/docs/modules/_standard_component_form.TJSSelect-1.html index 9e0b252..b1d068d 100644 --- a/docs/modules/_standard_component_form.TJSSelect-1.html +++ b/docs/modules/_standard_component_form.TJSSelect-1.html @@ -1,14 +1,3 @@ -TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Namespace TJSSelect

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSSelect | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Namespace TJSSelect

                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_form.html b/docs/modules/_standard_component_form.html index 0b5c55c..6fcafed 100644 --- a/docs/modules/_standard_component_form.html +++ b/docs/modules/_standard_component_form.html @@ -1,26 +1,2 @@ -#standard/component/form | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                            Package #standard/component/form

                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Classes

                                                                                                                                                                                                                                                                            TJSButton -TJSInput -TJSInputCheckbox -TJSInputNumber -TJSInputRange -TJSInputRangeNumber -TJSInputText -TJSSelect -

                                                                                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                                                                                            TJSButton -TJSInput -TJSInputCheckbox -TJSInputNumber -TJSInputRange -TJSInputRangeNumber -TJSInputText -TJSSelect -
                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                            \ No newline at end of file +#standard/component/form | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                              Package #standard/component/form

                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                              TJSButton
                                                                                                                                                                                                                                                                              TJSInput
                                                                                                                                                                                                                                                                              TJSInputCheckbox
                                                                                                                                                                                                                                                                              TJSInputNumber
                                                                                                                                                                                                                                                                              TJSInputRange
                                                                                                                                                                                                                                                                              TJSInputRangeNumber
                                                                                                                                                                                                                                                                              TJSInputText
                                                                                                                                                                                                                                                                              TJSSelect

                                                                                                                                                                                                                                                                              Namespaces

                                                                                                                                                                                                                                                                              TJSButton
                                                                                                                                                                                                                                                                              TJSInput
                                                                                                                                                                                                                                                                              TJSInputCheckbox
                                                                                                                                                                                                                                                                              TJSInputNumber
                                                                                                                                                                                                                                                                              TJSInputRange
                                                                                                                                                                                                                                                                              TJSInputRangeNumber
                                                                                                                                                                                                                                                                              TJSInputText
                                                                                                                                                                                                                                                                              TJSSelect

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Classes
                                                                                                                                                                                                                                                                              Namespaces
                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_editor.TJSContentEdit-1.html b/docs/modules/_standard_component_fvtt_editor.TJSContentEdit-1.html index f9689f1..8d7670e 100644 --- a/docs/modules/_standard_component_fvtt_editor.TJSContentEdit-1.html +++ b/docs/modules/_standard_component_fvtt_editor.TJSContentEdit-1.html @@ -1,14 +1,3 @@ -TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Namespace TJSContentEdit

                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                              Events -Props -Slots -
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                              \ No newline at end of file +TJSContentEdit | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Namespace TJSContentEdit

                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                              Events
                                                                                                                                                                                                                                                                              Props
                                                                                                                                                                                                                                                                              Slots

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Type Aliases
                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_editor.TJSProseMirror-1.html b/docs/modules/_standard_component_fvtt_editor.TJSProseMirror-1.html index e246699..0e5de22 100644 --- a/docs/modules/_standard_component_fvtt_editor.TJSProseMirror-1.html +++ b/docs/modules/_standard_component_fvtt_editor.TJSProseMirror-1.html @@ -1,14 +1,3 @@ -TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Namespace TJSProseMirror

                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                              Events -Props -Slots -
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                              \ No newline at end of file +TJSProseMirror | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Namespace TJSProseMirror

                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                              Events
                                                                                                                                                                                                                                                                              Props
                                                                                                                                                                                                                                                                              Slots

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Type Aliases
                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_editor.TJSTinyMCE-1.html b/docs/modules/_standard_component_fvtt_editor.TJSTinyMCE-1.html index a3855cb..78a6ca0 100644 --- a/docs/modules/_standard_component_fvtt_editor.TJSTinyMCE-1.html +++ b/docs/modules/_standard_component_fvtt_editor.TJSTinyMCE-1.html @@ -1,14 +1,3 @@ -TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Namespace TJSTinyMCE

                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                              Events -Props -Slots -
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                              \ No newline at end of file +TJSTinyMCE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Namespace TJSTinyMCE

                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                              Events
                                                                                                                                                                                                                                                                              Props
                                                                                                                                                                                                                                                                              Slots

                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                              Type Aliases
                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_editor.html b/docs/modules/_standard_component_fvtt_editor.html index be9f618..10192d1 100644 --- a/docs/modules/_standard_component_fvtt_editor.html +++ b/docs/modules/_standard_component_fvtt_editor.html @@ -1,21 +1,2 @@ -#standard/component/fvtt/editor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                Package #standard/component/fvtt/editor

                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                                TinyMCEHelper -TJSContentEdit -TJSProseMirror -TJSTinyMCE -

                                                                                                                                                                                                                                                                                Namespaces

                                                                                                                                                                                                                                                                                TJSContentEdit -TJSProseMirror -TJSTinyMCE -

                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                PMEditorExtra -TJSContentEditOptions -TJSProseMirrorOptions -TJSTinyMCEOptions -
                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                \ No newline at end of file +#standard/component/fvtt/editor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                  Package #standard/component/fvtt/editor

                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                  TinyMCEHelper
                                                                                                                                                                                                                                                                                  TJSContentEdit
                                                                                                                                                                                                                                                                                  TJSProseMirror
                                                                                                                                                                                                                                                                                  TJSTinyMCE

                                                                                                                                                                                                                                                                                  Namespaces

                                                                                                                                                                                                                                                                                  TJSContentEdit
                                                                                                                                                                                                                                                                                  TJSProseMirror
                                                                                                                                                                                                                                                                                  TJSTinyMCE

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  PMEditorExtra
                                                                                                                                                                                                                                                                                  TJSContentEditOptions
                                                                                                                                                                                                                                                                                  TJSProseMirrorOptions
                                                                                                                                                                                                                                                                                  TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Classes
                                                                                                                                                                                                                                                                                  Namespaces
                                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileButton-1.html b/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileButton-1.html index 0b0ab7e..e53be2b 100644 --- a/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileButton-1.html +++ b/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileButton-1.html @@ -1,14 +1,3 @@ -TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Namespace TJSFileButton

                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  Events -Props -Slots -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                  \ No newline at end of file +TJSFileButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Namespace TJSFileButton

                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  Events
                                                                                                                                                                                                                                                                                  Props
                                                                                                                                                                                                                                                                                  Slots

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.html b/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.html index 18e9b6e..4f70c6f 100644 --- a/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.html +++ b/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.html @@ -1,14 +1,3 @@ -TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Namespace TJSFileIconButton

                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  Events -Props -Slots -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                  \ No newline at end of file +TJSFileIconButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Namespace TJSFileIconButton

                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  Events
                                                                                                                                                                                                                                                                                  Props
                                                                                                                                                                                                                                                                                  Slots

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.html b/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.html index f9adce4..fa1a953 100644 --- a/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.html +++ b/docs/modules/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.html @@ -1,14 +1,3 @@ -TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Namespace TJSFileSlotButton

                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  Events -Props -Slots -
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                  \ No newline at end of file +TJSFileSlotButton | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Namespace TJSFileSlotButton

                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                  Events
                                                                                                                                                                                                                                                                                  Props
                                                                                                                                                                                                                                                                                  Slots

                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                  Type Aliases
                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_filepicker_button.html b/docs/modules/_standard_component_fvtt_filepicker_button.html index 1d756d2..8da57a6 100644 --- a/docs/modules/_standard_component_fvtt_filepicker_button.html +++ b/docs/modules/_standard_component_fvtt_filepicker_button.html @@ -1,16 +1,2 @@ -#standard/component/fvtt/filepicker/button | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                    Package #standard/component/fvtt/filepicker/button

                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                                    TJSFileButton -TJSFileIconButton -TJSFileSlotButton -

                                                                                                                                                                                                                                                                                    Namespaces

                                                                                                                                                                                                                                                                                    TJSFileButton -TJSFileIconButton -TJSFileSlotButton -
                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                    \ No newline at end of file +#standard/component/fvtt/filepicker/button | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                      Package #standard/component/fvtt/filepicker/button

                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                      TJSFileButton
                                                                                                                                                                                                                                                                                      TJSFileIconButton
                                                                                                                                                                                                                                                                                      TJSFileSlotButton

                                                                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                                                                      TJSFileButton
                                                                                                                                                                                                                                                                                      TJSFileIconButton
                                                                                                                                                                                                                                                                                      TJSFileSlotButton

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Classes
                                                                                                                                                                                                                                                                                      Namespaces
                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_settings.TJSSettingsEdit-1.html b/docs/modules/_standard_component_fvtt_settings.TJSSettingsEdit-1.html index 39eb316..bf65f7d 100644 --- a/docs/modules/_standard_component_fvtt_settings.TJSSettingsEdit-1.html +++ b/docs/modules/_standard_component_fvtt_settings.TJSSettingsEdit-1.html @@ -1,14 +1,3 @@ -TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Namespace TJSSettingsEdit

                                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                      Events -Props -Slots -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSSettingsEdit | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Namespace TJSSettingsEdit

                                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                      Events
                                                                                                                                                                                                                                                                                      Props
                                                                                                                                                                                                                                                                                      Slots

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_settings.TJSSettingsSwap-1.html b/docs/modules/_standard_component_fvtt_settings.TJSSettingsSwap-1.html index 4b43d7b..f453fb6 100644 --- a/docs/modules/_standard_component_fvtt_settings.TJSSettingsSwap-1.html +++ b/docs/modules/_standard_component_fvtt_settings.TJSSettingsSwap-1.html @@ -1,14 +1,3 @@ -TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Namespace TJSSettingsSwap

                                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                      Events -Props -Slots -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSSettingsSwap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Namespace TJSSettingsSwap

                                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                      Events
                                                                                                                                                                                                                                                                                      Props
                                                                                                                                                                                                                                                                                      Slots

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_settings.TJSThemeEditor-1.html b/docs/modules/_standard_component_fvtt_settings.TJSThemeEditor-1.html index 1891394..f8e38bc 100644 --- a/docs/modules/_standard_component_fvtt_settings.TJSThemeEditor-1.html +++ b/docs/modules/_standard_component_fvtt_settings.TJSThemeEditor-1.html @@ -1,14 +1,3 @@ -TJSThemeEditor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Namespace TJSThemeEditor

                                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                      Events -Props -Slots -
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                      \ No newline at end of file +TJSThemeEditor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Namespace TJSThemeEditor

                                                                                                                                                                                                                                                                                      Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                      Type Aliases

                                                                                                                                                                                                                                                                                      Events
                                                                                                                                                                                                                                                                                      Props
                                                                                                                                                                                                                                                                                      Slots

                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                      Member Visibility

                                                                                                                                                                                                                                                                                      On This Page

                                                                                                                                                                                                                                                                                      Type Aliases
                                                                                                                                                                                                                                                                                      \ No newline at end of file diff --git a/docs/modules/_standard_component_fvtt_settings.html b/docs/modules/_standard_component_fvtt_settings.html index e6eada1..77c2f00 100644 --- a/docs/modules/_standard_component_fvtt_settings.html +++ b/docs/modules/_standard_component_fvtt_settings.html @@ -1,16 +1,2 @@ -#standard/component/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                        Package #standard/component/fvtt/settings

                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                        TJSSettingsEdit -TJSSettingsSwap -TJSThemeEditor -

                                                                                                                                                                                                                                                                                        Namespaces

                                                                                                                                                                                                                                                                                        TJSSettingsEdit -TJSSettingsSwap -TJSThemeEditor -
                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                        \ No newline at end of file +#standard/component/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                          Package #standard/component/fvtt/settings

                                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                                          TJSSettingsEdit
                                                                                                                                                                                                                                                                                          TJSSettingsSwap
                                                                                                                                                                                                                                                                                          TJSThemeEditor

                                                                                                                                                                                                                                                                                          Namespaces

                                                                                                                                                                                                                                                                                          TJSSettingsEdit
                                                                                                                                                                                                                                                                                          TJSSettingsSwap
                                                                                                                                                                                                                                                                                          TJSThemeEditor

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Classes
                                                                                                                                                                                                                                                                                          Namespaces
                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_label.TJSSlotLabel-1.html b/docs/modules/_standard_component_label.TJSSlotLabel-1.html index 36470f1..1ca7d52 100644 --- a/docs/modules/_standard_component_label.TJSSlotLabel-1.html +++ b/docs/modules/_standard_component_label.TJSSlotLabel-1.html @@ -1,14 +1,3 @@ -TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Namespace TJSSlotLabel

                                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSSlotLabel | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Namespace TJSSlotLabel

                                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_label.TJSToggleLabel-1.html b/docs/modules/_standard_component_label.TJSToggleLabel-1.html index 96ae31e..bf540e4 100644 --- a/docs/modules/_standard_component_label.TJSToggleLabel-1.html +++ b/docs/modules/_standard_component_label.TJSToggleLabel-1.html @@ -1,14 +1,3 @@ -TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Namespace TJSToggleLabel

                                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                          Events -Props -Slots -
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                          \ No newline at end of file +TJSToggleLabel | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Namespace TJSToggleLabel

                                                                                                                                                                                                                                                                                          Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                          Events
                                                                                                                                                                                                                                                                                          Props
                                                                                                                                                                                                                                                                                          Slots

                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                          Member Visibility

                                                                                                                                                                                                                                                                                          On This Page

                                                                                                                                                                                                                                                                                          Type Aliases
                                                                                                                                                                                                                                                                                          \ No newline at end of file diff --git a/docs/modules/_standard_component_label.html b/docs/modules/_standard_component_label.html index 5a901c3..c4bd993 100644 --- a/docs/modules/_standard_component_label.html +++ b/docs/modules/_standard_component_label.html @@ -1,15 +1,2 @@ -#standard/component/label | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                            Package #standard/component/label

                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Classes

                                                                                                                                                                                                                                                                                            TJSSlotLabel -TJSSlotLabelUtil -TJSToggleLabel -

                                                                                                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                                                                                                            TJSSlotLabel -TJSToggleLabel -
                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                            \ No newline at end of file +#standard/component/label | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                            +

                                                                                                                                                                                                                                                                                              Package #standard/component/label

                                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                                              TJSSlotLabel
                                                                                                                                                                                                                                                                                              TJSSlotLabelUtil
                                                                                                                                                                                                                                                                                              TJSToggleLabel

                                                                                                                                                                                                                                                                                              Namespaces

                                                                                                                                                                                                                                                                                              TJSSlotLabel
                                                                                                                                                                                                                                                                                              TJSToggleLabel

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Classes
                                                                                                                                                                                                                                                                                              Namespaces
                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_layer_position.TJSPositionControlLayer-1.html b/docs/modules/_standard_component_layer_position.TJSPositionControlLayer-1.html index aa036ed..1131f38 100644 --- a/docs/modules/_standard_component_layer_position.TJSPositionControlLayer-1.html +++ b/docs/modules/_standard_component_layer_position.TJSPositionControlLayer-1.html @@ -1,14 +1,3 @@ -TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Namespace TJSPositionControlLayer

                                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                              -
                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                                              Events -Props -Slots -
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                              \ No newline at end of file +TJSPositionControlLayer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Namespace TJSPositionControlLayer

                                                                                                                                                                                                                                                                                              Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                              Type Aliases

                                                                                                                                                                                                                                                                                              Events
                                                                                                                                                                                                                                                                                              Props
                                                                                                                                                                                                                                                                                              Slots

                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                              Member Visibility

                                                                                                                                                                                                                                                                                              On This Page

                                                                                                                                                                                                                                                                                              Type Aliases
                                                                                                                                                                                                                                                                                              \ No newline at end of file diff --git a/docs/modules/_standard_component_layer_position.html b/docs/modules/_standard_component_layer_position.html index a393a18..16034ea 100644 --- a/docs/modules/_standard_component_layer_position.html +++ b/docs/modules/_standard_component_layer_position.html @@ -1,12 +1,2 @@ -#standard/component/layer/position | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                Package #standard/component/layer/position

                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                                                TJSPositionControlLayer -

                                                                                                                                                                                                                                                                                                Namespaces

                                                                                                                                                                                                                                                                                                TJSPositionControlLayer -
                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                \ No newline at end of file +#standard/component/layer/position | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                  Package #standard/component/layer/position

                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                  TJSPositionControlLayer

                                                                                                                                                                                                                                                                                                  Namespaces

                                                                                                                                                                                                                                                                                                  TJSPositionControlLayer

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility

                                                                                                                                                                                                                                                                                                  On This Page

                                                                                                                                                                                                                                                                                                  Classes
                                                                                                                                                                                                                                                                                                  Namespaces
                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_layer_side_slide.TJSSideSlideLayer-1.html b/docs/modules/_standard_component_layer_side_slide.TJSSideSlideLayer-1.html deleted file mode 100644 index 670a5fc..0000000 --- a/docs/modules/_standard_component_layer_side_slide.TJSSideSlideLayer-1.html +++ /dev/null @@ -1,14 +0,0 @@ -TJSSideSlideLayer | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Namespace TJSSideSlideLayer

                                                                                                                                                                                                                                                                                                  Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                                  Events -Props -Slots -
                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                  \ No newline at end of file diff --git a/docs/modules/_standard_component_layer_side_slide.html b/docs/modules/_standard_component_layer_side_slide.html deleted file mode 100644 index c6f0cce..0000000 --- a/docs/modules/_standard_component_layer_side_slide.html +++ /dev/null @@ -1,12 +0,0 @@ -#standard/component/layer/side-slide | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                    Package #standard/component/layer/side-slide

                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                                                    TJSSideSlideLayer -

                                                                                                                                                                                                                                                                                                    Namespaces

                                                                                                                                                                                                                                                                                                    TJSSideSlideLayer -
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component_media.TJSMediaContent-1.html b/docs/modules/_standard_component_media.TJSMediaContent-1.html index cfaebee..ed47104 100644 --- a/docs/modules/_standard_component_media.TJSMediaContent-1.html +++ b/docs/modules/_standard_component_media.TJSMediaContent-1.html @@ -1,14 +1,3 @@ -TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Namespace TJSMediaContent

                                                                                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                                                                                    Events -Props -Slots -
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSMediaContent | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Namespace TJSMediaContent

                                                                                                                                                                                                                                                                                                    Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                                                                                    Events
                                                                                                                                                                                                                                                                                                    Props
                                                                                                                                                                                                                                                                                                    Slots

                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/_standard_component_media.html b/docs/modules/_standard_component_media.html index c97c9c0..e472451 100644 --- a/docs/modules/_standard_component_media.html +++ b/docs/modules/_standard_component_media.html @@ -1,12 +1,2 @@ -#standard/component/media | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                      Package #standard/component/media

                                                                                                                                                                                                                                                                                                      - -

                                                                                                                                                                                                                                                                                                      - Index -

                                                                                                                                                                                                                                                                                                      -                                                                                                                                                                                                                                                                                                       -
                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      Classes

                                                                                                                                                                                                                                                                                                      TJSMediaContent -

                                                                                                                                                                                                                                                                                                      Namespaces

                                                                                                                                                                                                                                                                                                      TJSMediaContent -
                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                      \ No newline at end of file +#standard/component/media | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                        Package #standard/component/media

                                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                                        TJSMediaContent

                                                                                                                                                                                                                                                                                                        Namespaces

                                                                                                                                                                                                                                                                                                        TJSMediaContent

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Classes
                                                                                                                                                                                                                                                                                                        Namespaces
                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_menu.TJSMenu-1.html b/docs/modules/_standard_component_menu.TJSMenu-1.html index 1495277..5dfc69b 100644 --- a/docs/modules/_standard_component_menu.TJSMenu-1.html +++ b/docs/modules/_standard_component_menu.TJSMenu-1.html @@ -1,14 +1,3 @@ -TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Namespace TJSMenu

                                                                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                        Events -Props -Slots -
                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                        \ No newline at end of file +TJSMenu | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Namespace TJSMenu

                                                                                                                                                                                                                                                                                                        Event / Prop / Slot type aliases for associated component.

                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                        Events
                                                                                                                                                                                                                                                                                                        Props
                                                                                                                                                                                                                                                                                                        Slots

                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/_standard_component_menu.html b/docs/modules/_standard_component_menu.html index 72dc7d1..cd2d230 100644 --- a/docs/modules/_standard_component_menu.html +++ b/docs/modules/_standard_component_menu.html @@ -1,14 +1,2 @@ -#standard/component/menu | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                          Package #standard/component/menu

                                                                                                                                                                                                                                                                                                          - -

                                                                                                                                                                                                                                                                                                          - Index -

                                                                                                                                                                                                                                                                                                          -                                                                                                                                                                                                                                                                                                           -
                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Classes

                                                                                                                                                                                                                                                                                                          TJSMenu -

                                                                                                                                                                                                                                                                                                          Namespaces

                                                                                                                                                                                                                                                                                                          TJSMenu -

                                                                                                                                                                                                                                                                                                          Type Aliases

                                                                                                                                                                                                                                                                                                          TJSMenuData -TJSMenuItemData -
                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                          Settings

                                                                                                                                                                                                                                                                                                          Member Visibility
                                                                                                                                                                                                                                                                                                          \ No newline at end of file +#standard/component/menu | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                            Package #standard/component/menu

                                                                                                                                                                                                                                                                                                            Classes

                                                                                                                                                                                                                                                                                                            TJSMenu

                                                                                                                                                                                                                                                                                                            Namespaces

                                                                                                                                                                                                                                                                                                            TJSMenu

                                                                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                                                                            TJSMenuData
                                                                                                                                                                                                                                                                                                            TJSMenuItemData

                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                            Classes
                                                                                                                                                                                                                                                                                                            Namespaces
                                                                                                                                                                                                                                                                                                            Type Aliases
                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/_standard_fvtt.html b/docs/modules/_standard_fvtt.html index ba2791c..79b5e96 100644 --- a/docs/modules/_standard_fvtt.html +++ b/docs/modules/_standard_fvtt.html @@ -1,13 +1,2 @@ -#standard/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                              Package #standard/fvtt

                                                                                                                                                                                                                                                                                                              - -

                                                                                                                                                                                                                                                                                                              - Index -

                                                                                                                                                                                                                                                                                                              -                                                                                                                                                                                                                                                                                                               -
                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Classes

                                                                                                                                                                                                                                                                                                              FontManager -FoundryStyles -FVTTVersion -
                                                                                                                                                                                                                                                                                                              -

                                                                                                                                                                                                                                                                                                              Settings

                                                                                                                                                                                                                                                                                                              Member Visibility
                                                                                                                                                                                                                                                                                                              \ No newline at end of file +#standard/fvtt | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                Package #standard/fvtt

                                                                                                                                                                                                                                                                                                                Classes

                                                                                                                                                                                                                                                                                                                FontManager
                                                                                                                                                                                                                                                                                                                FoundryStyles
                                                                                                                                                                                                                                                                                                                FVTTVersion

                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                Classes
                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/_standard_store_fvtt_settings.html b/docs/modules/_standard_store_fvtt_settings.html index 3231bb2..a1d4759 100644 --- a/docs/modules/_standard_store_fvtt_settings.html +++ b/docs/modules/_standard_store_fvtt_settings.html @@ -1,20 +1,2 @@ -#standard/store/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                  Package #standard/store/fvtt/settings

                                                                                                                                                                                                                                                                                                                  - -

                                                                                                                                                                                                                                                                                                                  - Index -

                                                                                                                                                                                                                                                                                                                  -                                                                                                                                                                                                                                                                                                                   -
                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Classes

                                                                                                                                                                                                                                                                                                                  TJSGameSettingsWithUI -TJSThemeStore -

                                                                                                                                                                                                                                                                                                                  Interfaces

                                                                                                                                                                                                                                                                                                                  UIControl -

                                                                                                                                                                                                                                                                                                                  Type Aliases

                                                                                                                                                                                                                                                                                                                  TJSSettingsCreateOptions -TJSSettingsCustomSection -TJSSettingsCustomSectionFolder -TJSSettingsUIData -TJSThemeStoreComponent -TJSThemeStoreConfig -TJSThemeStoreOptions -
                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +#standard/store/fvtt/settings | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                    Package #standard/store/fvtt/settings

                                                                                                                                                                                                                                                                                                                    Classes

                                                                                                                                                                                                                                                                                                                    TJSGameSettingsWithUI
                                                                                                                                                                                                                                                                                                                    TJSThemeStore

                                                                                                                                                                                                                                                                                                                    Interfaces

                                                                                                                                                                                                                                                                                                                    UIControl

                                                                                                                                                                                                                                                                                                                    Type Aliases

                                                                                                                                                                                                                                                                                                                    TJSSettingsCreateOptions
                                                                                                                                                                                                                                                                                                                    TJSSettingsCustomSection
                                                                                                                                                                                                                                                                                                                    TJSSettingsCustomSectionFolder
                                                                                                                                                                                                                                                                                                                    TJSSettingsUIData
                                                                                                                                                                                                                                                                                                                    TJSThemeStoreComponent
                                                                                                                                                                                                                                                                                                                    TJSThemeStoreConfig
                                                                                                                                                                                                                                                                                                                    TJSThemeStoreOptions

                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                    Classes
                                                                                                                                                                                                                                                                                                                    Interfaces
                                                                                                                                                                                                                                                                                                                    Type Aliases
                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/svelte.html b/docs/modules/svelte.html index 87f1023..5083afa 100644 --- a/docs/modules/svelte.html +++ b/docs/modules/svelte.html @@ -1,32 +1,4 @@ -svelte | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                      Package svelte

                                                                                                                                                                                                                                                                                                                      Documentation: https://svelte.dev/docs/svelte

                                                                                                                                                                                                                                                                                                                      +svelte | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                        Package svelte

                                                                                                                                                                                                                                                                                                                        Documentation: https://svelte.dev/docs/svelte

                                                                                                                                                                                                                                                                                                                        Interactive Tutorial: https://svelte.dev/tutorial/basics

                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                                                        SvelteComponent -SvelteComponent_1 -SvelteComponentTyped -

                                                                                                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                                                                                                        afterUpdate -beforeUpdate -createEventDispatcher -getAllContexts -getContext -hasContext -onDestroy -onMount -setContext -tick -

                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                        ComponentConstructorOptions -DispatchOptions -EventDispatcher -

                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                        ComponentEvents -ComponentProps -ComponentType -NotFunction -
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                        Classes

                                                                                                                                                                                                                                                                                                                        SvelteComponent
                                                                                                                                                                                                                                                                                                                        SvelteComponent_1
                                                                                                                                                                                                                                                                                                                        SvelteComponentTyped

                                                                                                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                                                                                                        afterUpdate
                                                                                                                                                                                                                                                                                                                        beforeUpdate
                                                                                                                                                                                                                                                                                                                        createEventDispatcher
                                                                                                                                                                                                                                                                                                                        getAllContexts
                                                                                                                                                                                                                                                                                                                        getContext
                                                                                                                                                                                                                                                                                                                        hasContext
                                                                                                                                                                                                                                                                                                                        onDestroy
                                                                                                                                                                                                                                                                                                                        onMount
                                                                                                                                                                                                                                                                                                                        setContext
                                                                                                                                                                                                                                                                                                                        tick

                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                        ComponentConstructorOptions
                                                                                                                                                                                                                                                                                                                        DispatchOptions
                                                                                                                                                                                                                                                                                                                        EventDispatcher

                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                        ComponentEvents
                                                                                                                                                                                                                                                                                                                        ComponentProps
                                                                                                                                                                                                                                                                                                                        ComponentType
                                                                                                                                                                                                                                                                                                                        NotFunction

                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                        Classes
                                                                                                                                                                                                                                                                                                                        Functions
                                                                                                                                                                                                                                                                                                                        Interfaces
                                                                                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/svelte_action.html b/docs/modules/svelte_action.html index c63b770..32f1868 100644 --- a/docs/modules/svelte_action.html +++ b/docs/modules/svelte_action.html @@ -1,14 +1,4 @@ -svelte/action | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                          Package svelte/action

                                                                                                                                                                                                                                                                                                                          Documentation: https://svelte.dev/docs/svelte-action

                                                                                                                                                                                                                                                                                                                          +svelte/action | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                            Package svelte/action

                                                                                                                                                                                                                                                                                                                            Documentation: https://svelte.dev/docs/svelte-action

                                                                                                                                                                                                                                                                                                                            Interactive Tutorial: https://svelte.dev/tutorial/actions

                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                                                                                                                                            Action -ActionReturn -
                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                                                                                                                                            Action
                                                                                                                                                                                                                                                                                                                            ActionReturn

                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                            Interfaces
                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/svelte_animate.html b/docs/modules/svelte_animate.html index e974801..3b6b017 100644 --- a/docs/modules/svelte_animate.html +++ b/docs/modules/svelte_animate.html @@ -1,15 +1,4 @@ -svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                              Package svelte/animate

                                                                                                                                                                                                                                                                                                                              Documentation: https://svelte.dev/docs/svelte-animate

                                                                                                                                                                                                                                                                                                                              +svelte/animate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                Package svelte/animate

                                                                                                                                                                                                                                                                                                                                Documentation: https://svelte.dev/docs/svelte-animate

                                                                                                                                                                                                                                                                                                                                Interactive Tutorial: https://svelte.dev/tutorial/animate

                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                flip -

                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                AnimationConfig -FlipParams -
                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                flip

                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                AnimationConfig
                                                                                                                                                                                                                                                                                                                                FlipParams

                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                Functions
                                                                                                                                                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/modules/svelte_easing.html b/docs/modules/svelte_easing.html index c4ce2e7..54018f2 100644 --- a/docs/modules/svelte_easing.html +++ b/docs/modules/svelte_easing.html @@ -1,43 +1,4 @@ -svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                  Package svelte/easing

                                                                                                                                                                                                                                                                                                                                  Documentation: https://svelte.dev/docs/svelte-easing

                                                                                                                                                                                                                                                                                                                                  +svelte/easing | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                    Package svelte/easing

                                                                                                                                                                                                                                                                                                                                    Documentation: https://svelte.dev/docs/svelte-easing

                                                                                                                                                                                                                                                                                                                                    Interactive Easing Demo: https://svelte.dev/examples/easing

                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                    - -

                                                                                                                                                                                                                                                                                                                                    - Index -

                                                                                                                                                                                                                                                                                                                                    -                                                                                                                                                                                                                                                                                                                                     -
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                    Functions

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

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                    Functions

                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                    Member Visibility

                                                                                                                                                                                                                                                                                                                                    On This Page

                                                                                                                                                                                                                                                                                                                                    Functions
                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/modules/svelte_motion.html b/docs/modules/svelte_motion.html index 00dfdc7..95f8796 100644 --- a/docs/modules/svelte_motion.html +++ b/docs/modules/svelte_motion.html @@ -1,24 +1,4 @@ -svelte/motion | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                      Package svelte/motion

                                                                                                                                                                                                                                                                                                                                      Documentation: https://svelte.dev/docs/svelte-motion

                                                                                                                                                                                                                                                                                                                                      +svelte/motion | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                        Package svelte/motion

                                                                                                                                                                                                                                                                                                                                        Documentation: https://svelte.dev/docs/svelte-motion

                                                                                                                                                                                                                                                                                                                                        Interactive Tutorial: https://svelte.dev/tutorial/tweened

                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                        - -

                                                                                                                                                                                                                                                                                                                                        - Index -

                                                                                                                                                                                                                                                                                                                                        -                                                                                                                                                                                                                                                                                                                                         -
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                                                                                                                        spring -tweened -

                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                        Readable -Spring -SpringOpts -SpringUpdateOpts -Tweened -TweenedOptions -

                                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                                        Invalidator -Subscriber -Unsubscriber -Updater -
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                        Functions

                                                                                                                                                                                                                                                                                                                                        spring
                                                                                                                                                                                                                                                                                                                                        tweened

                                                                                                                                                                                                                                                                                                                                        Interfaces

                                                                                                                                                                                                                                                                                                                                        Readable
                                                                                                                                                                                                                                                                                                                                        Spring
                                                                                                                                                                                                                                                                                                                                        SpringOpts
                                                                                                                                                                                                                                                                                                                                        SpringUpdateOpts
                                                                                                                                                                                                                                                                                                                                        Tweened
                                                                                                                                                                                                                                                                                                                                        TweenedOptions

                                                                                                                                                                                                                                                                                                                                        Type Aliases

                                                                                                                                                                                                                                                                                                                                        Invalidator
                                                                                                                                                                                                                                                                                                                                        Subscriber
                                                                                                                                                                                                                                                                                                                                        Unsubscriber
                                                                                                                                                                                                                                                                                                                                        Updater

                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                        Member Visibility

                                                                                                                                                                                                                                                                                                                                        On This Page

                                                                                                                                                                                                                                                                                                                                        Functions
                                                                                                                                                                                                                                                                                                                                        Interfaces
                                                                                                                                                                                                                                                                                                                                        Type Aliases
                                                                                                                                                                                                                                                                                                                                        \ No newline at end of file diff --git a/docs/modules/svelte_store.html b/docs/modules/svelte_store.html index 9de68e4..7d57190 100644 --- a/docs/modules/svelte_store.html +++ b/docs/modules/svelte_store.html @@ -1,26 +1,4 @@ -svelte/store | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                          Package svelte/store

                                                                                                                                                                                                                                                                                                                                          Documentation: https://svelte.dev/docs/svelte-store

                                                                                                                                                                                                                                                                                                                                          +svelte/store | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                            Package svelte/store

                                                                                                                                                                                                                                                                                                                                            Documentation: https://svelte.dev/docs/svelte-store

                                                                                                                                                                                                                                                                                                                                            Interactive Tutorial: https://svelte.dev/tutorial/writable-stores

                                                                                                                                                                                                                                                                                                                                            -
                                                                                                                                                                                                                                                                                                                                            - -

                                                                                                                                                                                                                                                                                                                                            - Index -

                                                                                                                                                                                                                                                                                                                                            -                                                                                                                                                                                                                                                                                                                                             -
                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                                                                                                                                            derived -get -readable -readonly -writable -

                                                                                                                                                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                                                                                                                                                            Readable -Writable -

                                                                                                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                                                                                                            Invalidator -StartStopNotifier -Stores -StoresValues -Subscriber -Unsubscriber -Updater -
                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility
                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                            Functions

                                                                                                                                                                                                                                                                                                                                            derived
                                                                                                                                                                                                                                                                                                                                            get
                                                                                                                                                                                                                                                                                                                                            readable
                                                                                                                                                                                                                                                                                                                                            readonly
                                                                                                                                                                                                                                                                                                                                            writable

                                                                                                                                                                                                                                                                                                                                            Interfaces

                                                                                                                                                                                                                                                                                                                                            Readable
                                                                                                                                                                                                                                                                                                                                            Writable

                                                                                                                                                                                                                                                                                                                                            Type Aliases

                                                                                                                                                                                                                                                                                                                                            Invalidator
                                                                                                                                                                                                                                                                                                                                            StartStopNotifier
                                                                                                                                                                                                                                                                                                                                            Stores
                                                                                                                                                                                                                                                                                                                                            StoresValues
                                                                                                                                                                                                                                                                                                                                            Subscriber
                                                                                                                                                                                                                                                                                                                                            Unsubscriber
                                                                                                                                                                                                                                                                                                                                            Updater

                                                                                                                                                                                                                                                                                                                                            Settings

                                                                                                                                                                                                                                                                                                                                            Member Visibility

                                                                                                                                                                                                                                                                                                                                            On This Page

                                                                                                                                                                                                                                                                                                                                            Functions
                                                                                                                                                                                                                                                                                                                                            Interfaces
                                                                                                                                                                                                                                                                                                                                            Type Aliases
                                                                                                                                                                                                                                                                                                                                            \ No newline at end of file diff --git a/docs/modules/svelte_transition.html b/docs/modules/svelte_transition.html index 73c3c59..5b55c9c 100644 --- a/docs/modules/svelte_transition.html +++ b/docs/modules/svelte_transition.html @@ -1,28 +1,4 @@ -svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                              Package svelte/transition

                                                                                                                                                                                                                                                                                                                                              Documentation: https://svelte.dev/docs/svelte-transition

                                                                                                                                                                                                                                                                                                                                              +svelte/transition | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                              +

                                                                                                                                                                                                                                                                                                                                                Package svelte/transition

                                                                                                                                                                                                                                                                                                                                                Documentation: https://svelte.dev/docs/svelte-transition

                                                                                                                                                                                                                                                                                                                                                Interactive Tutorial: https://svelte.dev/tutorial/transition

                                                                                                                                                                                                                                                                                                                                                -
                                                                                                                                                                                                                                                                                                                                                - -

                                                                                                                                                                                                                                                                                                                                                - Index -

                                                                                                                                                                                                                                                                                                                                                -                                                                                                                                                                                                                                                                                                                                                 -
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                                blur -crossfade -draw -fade -fly -scale -slide -

                                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                                BlurParams -CrossfadeParams -DrawParams -FadeParams -FlyParams -ScaleParams -SlideParams -TransitionConfig -

                                                                                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                                                                                EasingFunction -
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                Functions

                                                                                                                                                                                                                                                                                                                                                blur
                                                                                                                                                                                                                                                                                                                                                crossfade
                                                                                                                                                                                                                                                                                                                                                draw
                                                                                                                                                                                                                                                                                                                                                fade
                                                                                                                                                                                                                                                                                                                                                fly
                                                                                                                                                                                                                                                                                                                                                scale
                                                                                                                                                                                                                                                                                                                                                slide

                                                                                                                                                                                                                                                                                                                                                Interfaces

                                                                                                                                                                                                                                                                                                                                                BlurParams
                                                                                                                                                                                                                                                                                                                                                CrossfadeParams
                                                                                                                                                                                                                                                                                                                                                DrawParams
                                                                                                                                                                                                                                                                                                                                                FadeParams
                                                                                                                                                                                                                                                                                                                                                FlyParams
                                                                                                                                                                                                                                                                                                                                                ScaleParams
                                                                                                                                                                                                                                                                                                                                                SlideParams
                                                                                                                                                                                                                                                                                                                                                TransitionConfig

                                                                                                                                                                                                                                                                                                                                                Type Aliases

                                                                                                                                                                                                                                                                                                                                                EasingFunction

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility

                                                                                                                                                                                                                                                                                                                                                On This Page

                                                                                                                                                                                                                                                                                                                                                Functions
                                                                                                                                                                                                                                                                                                                                                Interfaces
                                                                                                                                                                                                                                                                                                                                                Type Aliases
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.AnyColor.html b/docs/types/_runtime_data_color_colord.AnyColor.html index 97af38a..2b60cdc 100644 --- a/docs/types/_runtime_data_color_colord.AnyColor.html +++ b/docs/types/_runtime_data_color_colord.AnyColor.html @@ -1,2 +1,2 @@ -AnyColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias AnyColor

                                                                                                                                                                                                                                                                                                                                                AnyColor: string | ObjectColor

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +AnyColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias AnyColor

                                                                                                                                                                                                                                                                                                                                                AnyColor: string | ObjectColor

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.HslColor.html b/docs/types/_runtime_data_color_colord.HslColor.html index 2bb7dda..475a83f 100644 --- a/docs/types/_runtime_data_color_colord.HslColor.html +++ b/docs/types/_runtime_data_color_colord.HslColor.html @@ -1,2 +1,2 @@ -HslColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias HslColor

                                                                                                                                                                                                                                                                                                                                                HslColor: {
                                                                                                                                                                                                                                                                                                                                                    h: number;
                                                                                                                                                                                                                                                                                                                                                    l: number;
                                                                                                                                                                                                                                                                                                                                                    s: number;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +HslColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_data_color_colord.HslaColor.html b/docs/types/_runtime_data_color_colord.HslaColor.html index 65da522..dadd760 100644 --- a/docs/types/_runtime_data_color_colord.HslaColor.html +++ b/docs/types/_runtime_data_color_colord.HslaColor.html @@ -1,2 +1,2 @@ -HslaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias HslaColor

                                                                                                                                                                                                                                                                                                                                                HslaColor: WithAlpha<HslColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +HslaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias HslaColor

                                                                                                                                                                                                                                                                                                                                                HslaColor: WithAlpha<HslColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.HsvColor.html b/docs/types/_runtime_data_color_colord.HsvColor.html index 5489524..ff46d19 100644 --- a/docs/types/_runtime_data_color_colord.HsvColor.html +++ b/docs/types/_runtime_data_color_colord.HsvColor.html @@ -1,2 +1,2 @@ -HsvColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias HsvColor

                                                                                                                                                                                                                                                                                                                                                HsvColor: {
                                                                                                                                                                                                                                                                                                                                                    h: number;
                                                                                                                                                                                                                                                                                                                                                    s: number;
                                                                                                                                                                                                                                                                                                                                                    v: number;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +HsvColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_data_color_colord.HsvaColor.html b/docs/types/_runtime_data_color_colord.HsvaColor.html index 577feaa..f7590e1 100644 --- a/docs/types/_runtime_data_color_colord.HsvaColor.html +++ b/docs/types/_runtime_data_color_colord.HsvaColor.html @@ -1,2 +1,2 @@ -HsvaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias HsvaColor

                                                                                                                                                                                                                                                                                                                                                HsvaColor: WithAlpha<HsvColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +HsvaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias HsvaColor

                                                                                                                                                                                                                                                                                                                                                HsvaColor: WithAlpha<HsvColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.HwbColor.html b/docs/types/_runtime_data_color_colord.HwbColor.html index f8432e4..6aef6a2 100644 --- a/docs/types/_runtime_data_color_colord.HwbColor.html +++ b/docs/types/_runtime_data_color_colord.HwbColor.html @@ -1,2 +1,2 @@ -HwbColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias HwbColor

                                                                                                                                                                                                                                                                                                                                                HwbColor: {
                                                                                                                                                                                                                                                                                                                                                    b: number;
                                                                                                                                                                                                                                                                                                                                                    h: number;
                                                                                                                                                                                                                                                                                                                                                    w: number;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +HwbColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_data_color_colord.HwbaColor.html b/docs/types/_runtime_data_color_colord.HwbaColor.html index 00b1eea..0185315 100644 --- a/docs/types/_runtime_data_color_colord.HwbaColor.html +++ b/docs/types/_runtime_data_color_colord.HwbaColor.html @@ -1,2 +1,2 @@ -HwbaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias HwbaColor

                                                                                                                                                                                                                                                                                                                                                HwbaColor: WithAlpha<HwbColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +HwbaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias HwbaColor

                                                                                                                                                                                                                                                                                                                                                HwbaColor: WithAlpha<HwbColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.LabaColor.html b/docs/types/_runtime_data_color_colord.LabaColor.html index 304320a..f0b0606 100644 --- a/docs/types/_runtime_data_color_colord.LabaColor.html +++ b/docs/types/_runtime_data_color_colord.LabaColor.html @@ -1,2 +1,2 @@ -LabaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias LabaColor

                                                                                                                                                                                                                                                                                                                                                LabaColor: LabColor & {
                                                                                                                                                                                                                                                                                                                                                    alpha: number;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +LabaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias LabaColor

                                                                                                                                                                                                                                                                                                                                                LabaColor: LabColor & { alpha: number }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.LchaColor.html b/docs/types/_runtime_data_color_colord.LchaColor.html index fe03bf3..43ef822 100644 --- a/docs/types/_runtime_data_color_colord.LchaColor.html +++ b/docs/types/_runtime_data_color_colord.LchaColor.html @@ -1,2 +1,2 @@ -LchaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias LchaColor

                                                                                                                                                                                                                                                                                                                                                LchaColor: WithAlpha<LchColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +LchaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias LchaColor

                                                                                                                                                                                                                                                                                                                                                LchaColor: WithAlpha<LchColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.Plugin.html b/docs/types/_runtime_data_color_colord.Plugin.html index 7ef9575..81e66d9 100644 --- a/docs/types/_runtime_data_color_colord.Plugin.html +++ b/docs/types/_runtime_data_color_colord.Plugin.html @@ -1,2 +1,2 @@ -Plugin | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias Plugin

                                                                                                                                                                                                                                                                                                                                                Plugin: ((ColordClass: typeof Colord, parsers: Parsers) => void)

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +Plugin | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_data_color_colord.RgbColor.html b/docs/types/_runtime_data_color_colord.RgbColor.html index 3323579..a8fc425 100644 --- a/docs/types/_runtime_data_color_colord.RgbColor.html +++ b/docs/types/_runtime_data_color_colord.RgbColor.html @@ -1,2 +1,2 @@ -RgbColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias RgbColor

                                                                                                                                                                                                                                                                                                                                                RgbColor: {
                                                                                                                                                                                                                                                                                                                                                    b: number;
                                                                                                                                                                                                                                                                                                                                                    g: number;
                                                                                                                                                                                                                                                                                                                                                    r: number;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +RgbColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_data_color_colord.RgbaColor.html b/docs/types/_runtime_data_color_colord.RgbaColor.html index 767ebe9..6c6ba22 100644 --- a/docs/types/_runtime_data_color_colord.RgbaColor.html +++ b/docs/types/_runtime_data_color_colord.RgbaColor.html @@ -1,2 +1,2 @@ -RgbaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias RgbaColor

                                                                                                                                                                                                                                                                                                                                                RgbaColor: WithAlpha<RgbColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +RgbaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias RgbaColor

                                                                                                                                                                                                                                                                                                                                                RgbaColor: WithAlpha<RgbColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_color_colord.XyzaColor.html b/docs/types/_runtime_data_color_colord.XyzaColor.html index 26e1b9b..bd44085 100644 --- a/docs/types/_runtime_data_color_colord.XyzaColor.html +++ b/docs/types/_runtime_data_color_colord.XyzaColor.html @@ -1,2 +1,2 @@ -XyzaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias XyzaColor

                                                                                                                                                                                                                                                                                                                                                XyzaColor: WithAlpha<XyzColor>

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +XyzaColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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 fb4e22d..cf436c2 100644 --- a/docs/types/_runtime_data_compress.AsyncFlateDrainHandler.html +++ b/docs/types/_runtime_data_compress.AsyncFlateDrainHandler.html @@ -1,5 +1,5 @@ -AsyncFlateDrainHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +AsyncFlateDrainHandler | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias AsyncFlateDrainHandler

                                                                                                                                                                                                                                                                                                                                                      AsyncFlateDrainHandler: (size: number) => void

                                                                                                                                                                                                                                                                                                                                                      Handler for the asynchronous completion of (de)compression for a data chunk

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                        • (size: number): 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
                                                                                                                                                                                                                                                                                                                                                      \ 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 529037a..ebc6129 100644 --- a/docs/types/_runtime_data_compress.AsyncFlateStreamHandler.html +++ b/docs/types/_runtime_data_compress.AsyncFlateStreamHandler.html @@ -1,6 +1,6 @@ -AsyncFlateStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias AsyncFlateStreamHandler

                                                                                                                                                                                                                                                                                                                                                AsyncFlateStreamHandler: ((err: FlateError | null, data: Uint8Array, final: boolean) => void)

                                                                                                                                                                                                                                                                                                                                                Handler for asynchronous data (de)compression streams

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 92989cc..59fe033 100644 --- a/docs/types/_runtime_data_compress.AsyncZippableFile.html +++ b/docs/types/_runtime_data_compress.AsyncZippableFile.html @@ -1,3 +1,3 @@ -AsyncZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +AsyncZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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 d780037..c2c7536 100644 --- a/docs/types/_runtime_data_compress.FlateCallback.html +++ b/docs/types/_runtime_data_compress.FlateCallback.html @@ -1,5 +1,5 @@ -FlateCallback | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias FlateCallback

                                                                                                                                                                                                                                                                                                                                                FlateCallback: ((err: FlateError | null, data: Uint8Array) => void)

                                                                                                                                                                                                                                                                                                                                                Callback for asynchronous (de)compression methods

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 96cb484..ed0ae88 100644 --- a/docs/types/_runtime_data_compress.FlateStreamHandler.html +++ b/docs/types/_runtime_data_compress.FlateStreamHandler.html @@ -1,5 +1,5 @@ -FlateStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias FlateStreamHandler

                                                                                                                                                                                                                                                                                                                                                FlateStreamHandler: ((data: Uint8Array, final: boolean) => void)

                                                                                                                                                                                                                                                                                                                                                Handler for data (de)compression streams

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 974770f..9e14c20 100644 --- a/docs/types/_runtime_data_compress.GunzipMemberHandler.html +++ b/docs/types/_runtime_data_compress.GunzipMemberHandler.html @@ -1,4 +1,4 @@ -GunzipMemberHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +GunzipMemberHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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: number): void

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • offset: number

                                                                                                                                                                                                                                                                                                                                                      The offset of the new member relative to the start of the stream

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    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 f99fe08..7623218 100644 --- a/docs/types/_runtime_data_compress.StringStreamHandler.html +++ b/docs/types/_runtime_data_compress.StringStreamHandler.html @@ -1,5 +1,5 @@ -StringStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                      +StringStreamHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias StringStreamHandler

                                                                                                                                                                                                                                                                                                                                                      StringStreamHandler: (data: string, final: boolean) => void

                                                                                                                                                                                                                                                                                                                                                      Handler for string generation streams

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                        • (data: string, final: boolean): void

                                                                                                                                                                                                                                                                                                                                                        • Parameters

                                                                                                                                                                                                                                                                                                                                                          • data: string

                                                                                                                                                                                                                                                                                                                                                            The string output from the stream processor

                                                                                                                                                                                                                                                                                                                                                          • final: boolean

                                                                                                                                                                                                                                                                                                                                                            Whether this is the final block

                                                                                                                                                                                                                                                                                                                                                            -

                                                                                                                                                                                                                                                                                                                                                          Returns void

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ 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 4f2004b..08a5843 100644 --- a/docs/types/_runtime_data_compress.UnzipCallback.html +++ b/docs/types/_runtime_data_compress.UnzipCallback.html @@ -1,5 +1,5 @@ -UnzipCallback | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias UnzipCallback

                                                                                                                                                                                                                                                                                                                                                UnzipCallback: ((err: FlateError | null, data: Unzipped) => void)

                                                                                                                                                                                                                                                                                                                                                Callback for asynchronous ZIP decompression

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 5f40efd..4a43756 100644 --- a/docs/types/_runtime_data_compress.UnzipFileFilter.html +++ b/docs/types/_runtime_data_compress.UnzipFileFilter.html @@ -1,5 +1,5 @@ -UnzipFileFilter | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias UnzipFileFilter

                                                                                                                                                                                                                                                                                                                                                UnzipFileFilter: ((file: UnzipFileInfo) => boolean)

                                                                                                                                                                                                                                                                                                                                                A filter for files to be extracted during the unzipping process

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 9b81997..4c2994c 100644 --- a/docs/types/_runtime_data_compress.UnzipFileHandler.html +++ b/docs/types/_runtime_data_compress.UnzipFileHandler.html @@ -1,4 +1,4 @@ -UnzipFileHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +UnzipFileHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias UnzipFileHandler

                                                                                                                                                                                                                                                                                                                                                UnzipFileHandler: (file: UnzipFile) => void

                                                                                                                                                                                                                                                                                                                                                Handler for streaming ZIP decompression

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                  • (file: UnzipFile): void

                                                                                                                                                                                                                                                                                                                                                  • Parameters

                                                                                                                                                                                                                                                                                                                                                    • file: UnzipFile

                                                                                                                                                                                                                                                                                                                                                      The file that was found in the archive

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    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 f667b63..53f0118 100644 --- a/docs/types/_runtime_data_compress.ZippableFile.html +++ b/docs/types/_runtime_data_compress.ZippableFile.html @@ -1,3 +1,3 @@ -ZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +ZippableFile | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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 d14ca55..3eb6830 100644 --- a/docs/types/_runtime_data_format_json5.StringifyOptions.html +++ b/docs/types/_runtime_data_format_json5.StringifyOptions.html @@ -1,12 +1,12 @@ -StringifyOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +StringifyOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Optionalreplacer?: ((this: any, key: string, value: any) => 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Optionalspace?: 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 @@ -15,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
                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_format_jsonc.EditResult.html b/docs/types/_runtime_data_format_jsonc.EditResult.html index 6c26d46..70a5efc 100644 --- a/docs/types/_runtime_data_format_jsonc.EditResult.html +++ b/docs/types/_runtime_data_format_jsonc.EditResult.html @@ -1,5 +1,5 @@ -EditResult | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias EditResult

                                                                                                                                                                                                                                                                                                                                                EditResult: Edit[]

                                                                                                                                                                                                                                                                                                                                                An edit result describes a textual edit operation. It is the result of a format and modify operation. +EditResult | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias EditResult

                                                                                                                                                                                                                                                                                                                                                EditResult: Edit[]

                                                                                                                                                                                                                                                                                                                                                An edit result describes a textual edit operation. It is the result of a format and modify operation. It consist of one or more edits describing insertions, replacements or removals of text segments.

                                                                                                                                                                                                                                                                                                                                                • The offsets of the edits refer to the original state of the document.
                                                                                                                                                                                                                                                                                                                                                  • @@ -9,4 +9,4 @@ To apply an edit result use applyEdits. In general multiple EditResults must not be concatenated because they might impact each other, producing incorrect or malformed JSON data.
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_format_jsonc.JSONPath.html b/docs/types/_runtime_data_format_jsonc.JSONPath.html index b26e798..cc16dfe 100644 --- a/docs/types/_runtime_data_format_jsonc.JSONPath.html +++ b/docs/types/_runtime_data_format_jsonc.JSONPath.html @@ -1,2 +1,2 @@ -JSONPath | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias JSONPath

                                                                                                                                                                                                                                                                                                                                                JSONPath: Segment[]

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +JSONPath | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias JSONPath

                                                                                                                                                                                                                                                                                                                                                JSONPath: Segment[]

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_format_jsonc.NodeType.html b/docs/types/_runtime_data_format_jsonc.NodeType.html index 1c17d05..902e516 100644 --- a/docs/types/_runtime_data_format_jsonc.NodeType.html +++ b/docs/types/_runtime_data_format_jsonc.NodeType.html @@ -1,2 +1,2 @@ -NodeType | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias NodeType

                                                                                                                                                                                                                                                                                                                                                NodeType:
                                                                                                                                                                                                                                                                                                                                                    | "object"
                                                                                                                                                                                                                                                                                                                                                    | "array"
                                                                                                                                                                                                                                                                                                                                                    | "property"
                                                                                                                                                                                                                                                                                                                                                    | "string"
                                                                                                                                                                                                                                                                                                                                                    | "number"
                                                                                                                                                                                                                                                                                                                                                    | "boolean"
                                                                                                                                                                                                                                                                                                                                                    | "null"

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +NodeType | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias NodeType

                                                                                                                                                                                                                                                                                                                                                NodeType:
                                                                                                                                                                                                                                                                                                                                                    | "object"
                                                                                                                                                                                                                                                                                                                                                    | "array"
                                                                                                                                                                                                                                                                                                                                                    | "property"
                                                                                                                                                                                                                                                                                                                                                    | "string"
                                                                                                                                                                                                                                                                                                                                                    | "number"
                                                                                                                                                                                                                                                                                                                                                    | "boolean"
                                                                                                                                                                                                                                                                                                                                                    | "null"

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_format_jsonc.Segment.html b/docs/types/_runtime_data_format_jsonc.Segment.html index c11b201..f8ebc3d 100644 --- a/docs/types/_runtime_data_format_jsonc.Segment.html +++ b/docs/types/_runtime_data_format_jsonc.Segment.html @@ -1,4 +1,4 @@ -Segment | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias Segment

                                                                                                                                                                                                                                                                                                                                                Segment: string | number

                                                                                                                                                                                                                                                                                                                                                A JSONPath segment. Either a string representing an object property name +Segment | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias Segment

                                                                                                                                                                                                                                                                                                                                                Segment: string | number

                                                                                                                                                                                                                                                                                                                                                A JSONPath segment. Either a string representing an object property name or a number (starting at 0) for array indices.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_data_format_msgpack.UnpackOptions.html b/docs/types/_runtime_data_format_msgpack.UnpackOptions.html index 7f6b880..986235e 100644 --- a/docs/types/_runtime_data_format_msgpack.UnpackOptions.html +++ b/docs/types/_runtime_data_format_msgpack.UnpackOptions.html @@ -1,2 +1,2 @@ -UnpackOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias UnpackOptions

                                                                                                                                                                                                                                                                                                                                                UnpackOptions: {
                                                                                                                                                                                                                                                                                                                                                    end?: number;
                                                                                                                                                                                                                                                                                                                                                    lazy?: boolean;
                                                                                                                                                                                                                                                                                                                                                    start?: number;
                                                                                                                                                                                                                                                                                                                                                } | number

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +UnpackOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias UnpackOptions

                                                                                                                                                                                                                                                                                                                                                UnpackOptions: { end?: number; lazy?: boolean; start?: number } | number

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index b6d51c9..0000000 --- a/docs/types/_runtime_data_struct_cache_quick_lru.Options.html +++ /dev/null @@ -1,10 +0,0 @@ -Options | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • 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
                                                                                                                                                                                                                                                                                                                                                \ 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 e3b4508..f64f3f0 100644 --- a/docs/types/_runtime_data_struct_hash_array.HashArrayOptions.html +++ b/docs/types/_runtime_data_struct_hash_array.HashArrayOptions.html @@ -1,5 +1,5 @@ -HashArrayOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +HashArrayOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias HashArrayOptions<T>

                                                                                                                                                                                                                                                                                                                                                HashArrayOptions: { 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 4d14afa..7067597 100644 --- a/docs/types/_runtime_data_struct_hash_array.Key.html +++ b/docs/types/_runtime_data_struct_hash_array.Key.html @@ -1,3 +1,3 @@ -Key | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +Key | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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 9ebc5c0..b2f8c52 100644 --- a/docs/types/_runtime_data_struct_hash_array.KeyFields.html +++ b/docs/types/_runtime_data_struct_hash_array.KeyFields.html @@ -1,4 +1,4 @@ -KeyFields | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 87a5c06..4fa92a5 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieNode.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieNode.html @@ -1,4 +1,4 @@ -TrieNode | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieNode<T>

                                                                                                                                                                                                                                                                                                                                                TrieNode: { [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

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ 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 d0335f6..d4cfbd0 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchOptions.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchOptions.html @@ -1,17 +1,17 @@ -TrieSearchOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +TrieSearchOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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.

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

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

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

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

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

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

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • 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 +
                                                                                                                                                                                                                                                                                                                                                • 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 c11c50d..63f91da 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerData.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerData.html @@ -1,8 +1,8 @@ -TrieSearchReducerData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +TrieSearchReducerData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieSearchReducerData<T>

                                                                                                                                                                                                                                                                                                                                                TrieSearchReducerData: {
                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                \ 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 1d254df..3d1d004 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerResetData.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchReducerResetData.html @@ -1,7 +1,7 @@ -TrieSearchReducerResetData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +TrieSearchReducerResetData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieSearchReducerResetData<T>

                                                                                                                                                                                                                                                                                                                                                TrieSearchReducerResetData: {
                                                                                                                                                                                                                                                                                                                                                    keyFields: KeyFields;
                                                                                                                                                                                                                                                                                                                                                    list: T[];
                                                                                                                                                                                                                                                                                                                                                    options: TrieSearchOptions;
                                                                                                                                                                                                                                                                                                                                                    phrases: string | Iterable<string>;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Data provided when resetting reducers.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                • T

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 4d8060f..460ab71 100644 --- a/docs/types/_runtime_data_struct_search_trie.TrieSearchSubscribeHandler.html +++ b/docs/types/_runtime_data_struct_search_trie.TrieSearchSubscribeHandler.html @@ -1,6 +1,6 @@ -TrieSearchSubscribeHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieSearchSubscribeHandler<T>

                                                                                                                                                                                                                                                                                                                                                TrieSearchSubscribeHandler<T>: (({ +TrieSearchSubscribeHandler | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieSearchSubscribeHandler<T>

                                                                                                                                                                                                                                                                                                                                                TrieSearchSubscribeHandler: (
                                                                                                                                                                                                                                                                                                                                                    { 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 +}                                                                                                                                                                                                                                                                                                                                                : {
                                                                                                                                                                                                                                                                                                                                                        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 c0df6ec..478f005 100644 --- a/docs/types/_runtime_data_struct_search_trie_query.TrieSearchQueryOptions.html +++ b/docs/types/_runtime_data_struct_search_trie_query.TrieSearchQueryOptions.html @@ -1,5 +1,5 @@ -TrieSearchQueryOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieSearchQueryOptions<T>

                                                                                                                                                                                                                                                                                                                                                TrieSearchQueryOptions<T>: {
                                                                                                                                                                                                                                                                                                                                                    limit?: number;
                                                                                                                                                                                                                                                                                                                                                    trieReducer?: TrieSearchReducer<T>;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Options for TrieSearchQuery.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                • T extends object

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                • Optionallimit?: number

                                                                                                                                                                                                                                                                                                                                                  The initial limit on search results.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • OptionaltrieReducer?: TrieSearchReducer<T>

                                                                                                                                                                                                                                                                                                                                                  An initial trie reducer instance to set.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +TrieSearchQueryOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TrieSearchQueryOptions<T>

                                                                                                                                                                                                                                                                                                                                                TrieSearchQueryOptions: { limit?: number; trieReducer?: TrieSearchReducer<T> }

                                                                                                                                                                                                                                                                                                                                                Options for TrieSearchQuery.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Parameters

                                                                                                                                                                                                                                                                                                                                                • T extends object

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                • Optionallimit?: number

                                                                                                                                                                                                                                                                                                                                                  The initial limit on search results.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • OptionaltrieReducer?: TrieSearchReducer<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 deleted file mode 100644 index b4c23ca..0000000 --- a/docs/types/_runtime_math_gl_matrix.FloatArray.html +++ /dev/null @@ -1,3 +0,0 @@ -FloatArray | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index da59687..0000000 --- a/docs/types/_runtime_math_gl_matrix.Mat2Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Mat2Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index aa0c22e..0000000 --- a/docs/types/_runtime_math_gl_matrix.Mat2dLike.html +++ /dev/null @@ -1,3 +0,0 @@ -Mat2dLike | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index 0d4a196..0000000 --- a/docs/types/_runtime_math_gl_matrix.Mat3Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Mat3Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index 7f66b5c..0000000 --- a/docs/types/_runtime_math_gl_matrix.Mat4Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Mat4Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index e0df25c..0000000 --- a/docs/types/_runtime_math_gl_matrix.Quat2Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Quat2Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index b30b363..0000000 --- a/docs/types/_runtime_math_gl_matrix.QuatLike.html +++ /dev/null @@ -1,3 +0,0 @@ -QuatLike | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index 48b3bcc..0000000 --- a/docs/types/_runtime_math_gl_matrix.Vec2Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Vec2Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index c462a58..0000000 --- a/docs/types/_runtime_math_gl_matrix.Vec3Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Vec3Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 deleted file mode 100644 index 07b5339..0000000 --- a/docs/types/_runtime_math_gl_matrix.Vec4Like.html +++ /dev/null @@ -1,3 +0,0 @@ -Vec4Like | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 1282378..066e742 100644 --- a/docs/types/_runtime_math_interpolate.InterpolateFunctionName.html +++ b/docs/types/_runtime_math_interpolate.InterpolateFunctionName.html @@ -1,3 +1,3 @@ -InterpolateFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias InterpolateFunctionName

                                                                                                                                                                                                                                                                                                                                                InterpolateFunctionName

                                                                                                                                                                                                                                                                                                                                                Defines the supported interpolation function names.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +InterpolateFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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 cd4535c..7813c5f 100644 --- a/docs/types/_runtime_plugin_manager.DataOutPluginEnabled.html +++ b/docs/types/_runtime_plugin_manager.DataOutPluginEnabled.html @@ -1,6 +1,6 @@ -DataOutPluginEnabled | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +DataOutPluginEnabled | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 0a18e47..aa5b2b9 100644 --- a/docs/types/_runtime_plugin_manager.DataOutPluginEvents.html +++ b/docs/types/_runtime_plugin_manager.DataOutPluginEvents.html @@ -1,5 +1,5 @@ -DataOutPluginEvents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +DataOutPluginEvents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 bf7bdce..7b2bdf8 100644 --- a/docs/types/_runtime_plugin_manager.DataOutPluginRemoved.html +++ b/docs/types/_runtime_plugin_manager.DataOutPluginRemoved.html @@ -1,6 +1,6 @@ -DataOutPluginRemoved | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +DataOutPluginRemoved | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 8480b90..4bd8001 100644 --- a/docs/types/_runtime_plugin_manager.PluginConfig.html +++ b/docs/types/_runtime_plugin_manager.PluginConfig.html @@ -1,9 +1,9 @@ -PluginConfig | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +PluginConfig | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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).

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

                                                                                                                                                                                                                                                                                                                                                  • 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
                                                                                                                                                                                                                                                                                                                                                  \ 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 dc35846..87c125c 100644 --- a/docs/types/_runtime_plugin_manager.PluginData.html +++ b/docs/types/_runtime_plugin_manager.PluginData.html @@ -1,6 +1,6 @@ -PluginData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +PluginData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • module: object

                                                                                                                                                                                                                                                                                                                                                  Optional object hash to associate with plugin.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • plugin: {
                                                                                                                                                                                                                                                                                                                                                      name: string;
                                                                                                                                                                                                                                                                                                                                                      options: object;
                                                                                                                                                                                                                                                                                                                                                      target: string;
                                                                                                                                                                                                                                                                                                                                                      targetEscaped: string;
                                                                                                                                                                                                                                                                                                                                                      type: string;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Data about the plugin.

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                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 82bc31c..c2a1b9e 100644 --- a/docs/types/_runtime_plugin_manager.PluginEventData.html +++ b/docs/types/_runtime_plugin_manager.PluginEventData.html @@ -1,4 +1,4 @@ -PluginEventData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 3dcdf9f..daa273b 100644 --- a/docs/types/_runtime_plugin_manager.PluginManagerOptions.html +++ b/docs/types/_runtime_plugin_manager.PluginManagerOptions.html @@ -1,17 +1,17 @@ -PluginManagerOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +PluginManagerOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalnoEventDestroy?: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalnoEventRemoval?: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalnoEventSetEnabled?: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalnoEventSetOptions?: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalthrowNoMethod?: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalthrowNoPlugin?: 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
                                                                                                                                                                                                                                                                                                                                                  \ 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 5f55389..951cb46 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventData.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventData.html @@ -1,9 +1,9 @@ -EventData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • Optionallistening?: object

                                                                                                                                                                                                                                                                                                                                                  Any associated listening instance.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • options: EventOptionsOut

                                                                                                                                                                                                                                                                                                                                                  Holds options for this event registration, One such option is 'guarded' which +EventData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • 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
                                                                                                                                                                                                                                                                                                                                                  \ 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 2c50e4a..1fbd7c7 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventMap.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventMap.html @@ -1,4 +1,4 @@ -EventMap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias EventMap

                                                                                                                                                                                                                                                                                                                                                EventMap: { [key: string]: Function }

                                                                                                                                                                                                                                                                                                                                                Defines multiple events that can be used to registered in one API call.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ 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 5ae9bdc..78fe369 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventOptions.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventOptions.html @@ -1,8 +1,8 @@ -EventOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +EventOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Optionaltype?: "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
                                                                                                                                                                                                                                                                                                                                                  \ 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 d2d1fb9..ffb7162 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventOptionsOut.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventOptionsOut.html @@ -1,5 +1,5 @@ -EventOptionsOut | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +EventOptionsOut | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 52534bd..2cddd64 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventbusEvents.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventbusEvents.html @@ -1,3 +1,3 @@ -EventbusEvents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias EventbusEvents

                                                                                                                                                                                                                                                                                                                                                EventbusEvents: {
                                                                                                                                                                                                                                                                                                                                                    [key: string]: EventData[];
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Event data stored by event name.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +EventbusEvents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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 2b77c02..1293845 100644 --- a/docs/types/_runtime_plugin_manager_eventbus.EventbusSecureObj.html +++ b/docs/types/_runtime_plugin_manager_eventbus.EventbusSecureObj.html @@ -1,7 +1,7 @@ -EventbusSecureObj | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias EventbusSecureObj

                                                                                                                                                                                                                                                                                                                                                EventbusSecureObj: {
                                                                                                                                                                                                                                                                                                                                                    destroy: Function;
                                                                                                                                                                                                                                                                                                                                                    eventbusSecure: EventbusSecure;
                                                                                                                                                                                                                                                                                                                                                    setEventbus: ((eventbus: Eventbus | EventbusProxy, name?: string) => void);
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                The control object returned by EventbusSecure.initialize.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_svelte_action_dom_input.UseTinykeysData.html b/docs/types/_runtime_svelte_action_dom_input.UseTinykeysData.html index b4398fd..9a7cbc1 100644 --- a/docs/types/_runtime_svelte_action_dom_input.UseTinykeysData.html +++ b/docs/types/_runtime_svelte_action_dom_input.UseTinykeysData.html @@ -1,5 +1,5 @@ -UseTinykeysData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias UseTinykeysData

                                                                                                                                                                                                                                                                                                                                                UseTinykeysData: {
                                                                                                                                                                                                                                                                                                                                                    keyBindingMap: KeyBindingMap;
                                                                                                                                                                                                                                                                                                                                                    options?: KeyBindingOptions;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 7303efc..b7adc6c 100644 --- a/docs/types/_runtime_svelte_action_util.DynamicActionOptions.html +++ b/docs/types/_runtime_svelte_action_util.DynamicActionOptions.html @@ -1,4 +1,4 @@ -DynamicActionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_svelte_animate_gsap.Action.DraggableGsapOptions.html b/docs/types/_runtime_svelte_animate_gsap.Action.DraggableGsapOptions.html index 45029a5..ffb1ccb 100644 --- a/docs/types/_runtime_svelte_animate_gsap.Action.DraggableGsapOptions.html +++ b/docs/types/_runtime_svelte_animate_gsap.Action.DraggableGsapOptions.html @@ -1,14 +1,14 @@ -DraggableGsapOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • 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 +DraggableGsapOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • 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_animate_gsap.Action.GsapInertiaOptions.html b/docs/types/_runtime_svelte_animate_gsap.Action.GsapInertiaOptions.html index 512185b..67377cb 100644 --- a/docs/types/_runtime_svelte_animate_gsap.Action.GsapInertiaOptions.html +++ b/docs/types/_runtime_svelte_animate_gsap.Action.GsapInertiaOptions.html @@ -1,8 +1,8 @@ -GsapInertiaOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +GsapInertiaOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • 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_animate_gsap.Action.GsapTweenOptions.html b/docs/types/_runtime_svelte_animate_gsap.Action.GsapTweenOptions.html index d459813..1b8d155 100644 --- a/docs/types/_runtime_svelte_animate_gsap.Action.GsapTweenOptions.html +++ b/docs/types/_runtime_svelte_animate_gsap.Action.GsapTweenOptions.html @@ -1,5 +1,5 @@ -GsapTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +GsapTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_animate_gsap.Compose.GsapData.html b/docs/types/_runtime_svelte_animate_gsap.Compose.GsapData.html index 5026ba4..450e9a7 100644 --- a/docs/types/_runtime_svelte_animate_gsap.Compose.GsapData.html +++ b/docs/types/_runtime_svelte_animate_gsap.Compose.GsapData.html @@ -1,2 +1,2 @@ -GsapData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias GsapData

                                                                                                                                                                                                                                                                                                                                                GsapData: Iterable<object> | Function

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +GsapData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias GsapData

                                                                                                                                                                                                                                                                                                                                                GsapData: Iterable<object> | Function

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_svelte_animate_gsap.Compose.GsapPositionOptions.html b/docs/types/_runtime_svelte_animate_gsap.Compose.GsapPositionOptions.html index 4c63473..d12876b 100644 --- a/docs/types/_runtime_svelte_animate_gsap.Compose.GsapPositionOptions.html +++ b/docs/types/_runtime_svelte_animate_gsap.Compose.GsapPositionOptions.html @@ -1,6 +1,6 @@ -GsapPositionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +GsapPositionOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalinitialProps?: 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
                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file diff --git a/docs/types/_runtime_svelte_animate_gsap.Compose.GsapTarget.html b/docs/types/_runtime_svelte_animate_gsap.Compose.GsapTarget.html index 6135bd7..34525d0 100644 --- a/docs/types/_runtime_svelte_animate_gsap.Compose.GsapTarget.html +++ b/docs/types/_runtime_svelte_animate_gsap.Compose.GsapTarget.html @@ -1,3 +1,3 @@ -GsapTarget | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +GsapTarget | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_animate_gsap.GsapEasingFunctionName.html b/docs/types/_runtime_svelte_animate_gsap.GsapEasingFunctionName.html index 7e0d18f..237a147 100644 --- a/docs/types/_runtime_svelte_animate_gsap.GsapEasingFunctionName.html +++ b/docs/types/_runtime_svelte_animate_gsap.GsapEasingFunctionName.html @@ -1,3 +1,3 @@ -GsapEasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +GsapEasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_animate_gsap.GsapEasingReference.html b/docs/types/_runtime_svelte_animate_gsap.GsapEasingReference.html index 7e53f2b..0feca28 100644 --- a/docs/types/_runtime_svelte_animate_gsap.GsapEasingReference.html +++ b/docs/types/_runtime_svelte_animate_gsap.GsapEasingReference.html @@ -1,3 +1,3 @@ -GsapEasingReference | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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 +GsapEasingReference | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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_application.ApplicationStateData.html b/docs/types/_runtime_svelte_application.ApplicationStateData.html index 2163132..ce394ec 100644 --- a/docs/types/_runtime_svelte_application.ApplicationStateData.html +++ b/docs/types/_runtime_svelte_application.ApplicationStateData.html @@ -1,7 +1,7 @@ -ApplicationStateData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +ApplicationStateData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                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 b006b48..c4b0446 100644 --- a/docs/types/_runtime_svelte_application.MountedAppShell.html +++ b/docs/types/_runtime_svelte_application.MountedAppShell.html @@ -1,6 +1,6 @@ -MountedAppShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias MountedAppShell

                                                                                                                                                                                                                                                                                                                                                MountedAppShell: {
                                                                                                                                                                                                                                                                                                                                                    elementContent?: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                    elementRoot: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                    elementTarget?: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Application shell contract for Svelte components.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                • OptionalelementContent?: HTMLElement

                                                                                                                                                                                                                                                                                                                                                  The content element / exported prop.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • elementRoot: HTMLElement

                                                                                                                                                                                                                                                                                                                                                  The root element / exported prop.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • OptionalelementTarget?: HTMLElement

                                                                                                                                                                                                                                                                                                                                                  The target element / exported prop.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +MountedAppShell | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias MountedAppShell

                                                                                                                                                                                                                                                                                                                                                MountedAppShell: {
                                                                                                                                                                                                                                                                                                                                                    elementContent?: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                    elementRoot: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                    elementTarget?: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Application shell contract for Svelte components.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                • OptionalelementContent?: HTMLElement

                                                                                                                                                                                                                                                                                                                                                  The content element / exported prop.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • elementRoot: HTMLElement

                                                                                                                                                                                                                                                                                                                                                  The root element / exported prop.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • OptionalelementTarget?: HTMLElement

                                                                                                                                                                                                                                                                                                                                                  The target element / exported prop.

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                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 03edec7..fb4bec3 100644 --- a/docs/types/_runtime_svelte_application.StoreAppOptions.html +++ b/docs/types/_runtime_svelte_application.StoreAppOptions.html @@ -1,17 +1,17 @@ -StoreAppOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • focusTrap: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for focusTrap updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoClose: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerButtonNoClose updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoLabel: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerButtonNoLabel updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerIcon: Writable<string>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerIcon updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerNoTitleMinimized: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerNoTitleMinimized updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • minimizable: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for minimizable updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • popOut: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for popOut updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • positionable: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for positionable updates.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • 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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +StoreAppOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • focusTrap: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for focusTrap updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoClose: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerButtonNoClose updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoLabel: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerButtonNoLabel updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerIcon: Writable<string>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerIcon updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerNoTitleMinimized: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for headerNoTitleMinimized updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • minimizable: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for minimizable updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • popOut: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for popOut updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • positionable: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                  Derived store for positionable updates.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • 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
                                                                                                                                                                                                                                                                                                                                                \ 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 014550f..5dc00a2 100644 --- a/docs/types/_runtime_svelte_application.StoreUIOptions.html +++ b/docs/types/_runtime_svelte_application.StoreUIOptions.html @@ -1,8 +1,8 @@ -StoreUIOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +StoreUIOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                \ 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 3bf892a..08ae209 100644 --- a/docs/types/_runtime_svelte_application.SvelteApplicationOptions.html +++ b/docs/types/_runtime_svelte_application.SvelteApplicationOptions.html @@ -1,35 +1,35 @@ -SvelteApplicationOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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?: ValidatorOption;
                                                                                                                                                                                                                                                                                                                                                    sessionStorage?: WebStorage;
                                                                                                                                                                                                                                                                                                                                                    svelte?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                    transformOrigin?: TransformOrigin;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Options for SvelteApplication. Note: that this extends the Foundry +SvelteApplicationOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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?: ValidatorOption;
                                                                                                                                                                                                                                                                                                                                                    sessionStorage?: WebStorage;
                                                                                                                                                                                                                                                                                                                                                    svelte?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                    transformOrigin?: TransformOrigin;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Options for SvelteApplication. Note: that this extends the Foundry ApplicationOptions.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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
                                                                                                                                                                                                                                                                                                                                                    +

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

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

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalminWidth?: number

                                                                                                                                                                                                                                                                                                                                                    Assigned to position. Number specifying minimum +

                                                                                                                                                                                                                                                                                                                                                  • OptionalminWidth?: number

                                                                                                                                                                                                                                                                                                                                                    Assigned to position. Number specifying minimum window width.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Optionalpositionable?: boolean

                                                                                                                                                                                                                                                                                                                                                    If false then position.set does not take effect.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalpositionInitial?: InitialSystem

                                                                                                                                                                                                                                                                                                                                                    A helper for +

                                                                                                                                                                                                                                                                                                                                                  • Optionalpositionable?: boolean

                                                                                                                                                                                                                                                                                                                                                    If false then position.set does not take effect.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • OptionalpositionInitial?: InitialSystem

                                                                                                                                                                                                                                                                                                                                                    A helper for initial position placement.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalpositionOrtho?: boolean

                                                                                                                                                                                                                                                                                                                                                    When true TJSPosition is optimized for orthographic use.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalpositionValidator?: ValidatorOption

                                                                                                                                                                                                                                                                                                                                                    A validator +

                                                                                                                                                                                                                                                                                                                                                  • OptionalpositionOrtho?: boolean

                                                                                                                                                                                                                                                                                                                                                    When true TJSPosition is optimized for orthographic use.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • OptionalpositionValidator?: ValidatorOption

                                                                                                                                                                                                                                                                                                                                                    A validator function or data or list of validators.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalsessionStorage?: WebStorage

                                                                                                                                                                                                                                                                                                                                                    An instance of +

                                                                                                                                                                                                                                                                                                                                                  • OptionalsessionStorage?: WebStorage

                                                                                                                                                                                                                                                                                                                                                    An instance of WebStorage (session) to share across SvelteApplications. This is only required to share a WebStorage instance across multiple SvelteApplications. By default, a unique TJSSessionStorage instance is created per SvelteApplication.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Optionalsvelte?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                    A Svelte configuration object defining +

                                                                                                                                                                                                                                                                                                                                                  • Optionalsvelte?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                    A Svelte configuration object defining the main component.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionaltransformOrigin?: TransformOrigin

                                                                                                                                                                                                                                                                                                                                                    By +

                                                                                                                                                                                                                                                                                                                                                  • OptionaltransformOrigin?: TransformOrigin

                                                                                                                                                                                                                                                                                                                                                    By default, 'top / left' respects rotation when minimizing.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ 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 8a1ed35..b12357f 100644 --- a/docs/types/_runtime_svelte_application.SvelteData.html +++ b/docs/types/_runtime_svelte_application.SvelteData.html @@ -1,6 +1,6 @@ -SvelteData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias SvelteData

                                                                                                                                                                                                                                                                                                                                                SvelteData: {
                                                                                                                                                                                                                                                                                                                                                    component: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                                    config: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                    element: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Provides access to a mounted Svelte component.

                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +SvelteData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias SvelteData

                                                                                                                                                                                                                                                                                                                                                SvelteData: {
                                                                                                                                                                                                                                                                                                                                                    component: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                                    config: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                    element: HTMLElement;
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Provides access to a mounted Svelte component.

                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                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 6ee078e..cbebd96 100644 --- a/docs/types/_runtime_svelte_application.SvelteReactiveData.html +++ b/docs/types/_runtime_svelte_application.SvelteReactiveData.html @@ -1,13 +1,13 @@ -SvelteReactiveData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • focusTrap: boolean

                                                                                                                                                                                                                                                                                                                                                  When true focus trapping / wrapping is enabled keeping focus inside app.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoClose: boolean

                                                                                                                                                                                                                                                                                                                                                  If true then the close header button is removed.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoLabel: boolean

                                                                                                                                                                                                                                                                                                                                                  If true then header button labels are removed.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • headerNoTitleMinimized: boolean

                                                                                                                                                                                                                                                                                                                                                  If true then header title is hidden when minimized.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • 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
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +SvelteReactiveData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                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.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • focusTrap: boolean

                                                                                                                                                                                                                                                                                                                                                  When true focus trapping / wrapping is enabled keeping focus inside app.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoClose: boolean

                                                                                                                                                                                                                                                                                                                                                  If true then the close header button is removed.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerButtonNoLabel: boolean

                                                                                                                                                                                                                                                                                                                                                  If true then header button labels are removed.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • headerNoTitleMinimized: boolean

                                                                                                                                                                                                                                                                                                                                                  If true then header title is hidden when minimized.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • 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
                                                                                                                                                                                                                                                                                                                                                \ 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 89247af..028f499 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogButtonData.html +++ b/docs/types/_runtime_svelte_application.TJSDialogButtonData.html @@ -1,10 +1,10 @@ -TJSDialogButtonData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias TJSDialogButtonData

                                                                                                                                                                                                                                                                                                                                                TJSDialogButtonData: {
                                                                                                                                                                                                                                                                                                                                                    autoClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                    condition?: boolean | (() => boolean);
                                                                                                                                                                                                                                                                                                                                                    icon?: string;
                                                                                                                                                                                                                                                                                                                                                    label?: string;
                                                                                                                                                                                                                                                                                                                                                    onPress?: string | ((data?: {
                                                                                                                                                                                                                                                                                                                                                        application?: TJSDialog;
                                                                                                                                                                                                                                                                                                                                                    }) => any);
                                                                                                                                                                                                                                                                                                                                                    styles?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                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 +TJSDialogButtonData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Type Alias TJSDialogButtonData

                                                                                                                                                                                                                                                                                                                                                  TJSDialogButtonData: {
                                                                                                                                                                                                                                                                                                                                                      autoClose?: boolean;
                                                                                                                                                                                                                                                                                                                                                      condition?: boolean | () => boolean;
                                                                                                                                                                                                                                                                                                                                                      icon?: string;
                                                                                                                                                                                                                                                                                                                                                      label?: string;
                                                                                                                                                                                                                                                                                                                                                      onPress?: string | (data?: { application?: TJSDialog }) => any;
                                                                                                                                                                                                                                                                                                                                                      styles?: { [key: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Inline styles to apply to the button.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                    • [key: string]: string | null

                                                                                                                                                                                                                                                                                                                                                  Settings

                                                                                                                                                                                                                                                                                                                                                  Member Visibility
                                                                                                                                                                                                                                                                                                                                                  \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                • Optionalstyles?: { [key: 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 7dea783..279b8d8 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogModalOptions.html +++ b/docs/types/_runtime_svelte_application.TJSDialogModalOptions.html @@ -1,9 +1,9 @@ -TJSDialogModalOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias TJSDialogModalOptions

                                                                                                                                                                                                                                                                                                                                                TJSDialogModalOptions: {
                                                                                                                                                                                                                                                                                                                                                    background?: string;
                                                                                                                                                                                                                                                                                                                                                    closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                                                                                    slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                                                                                    styles?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                    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?: {
                                                                                                                                                                                                                                                                                                                                                      [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  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

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  • [key: string]: string | null
                                                                                                                                                                                                                                                                                                                                                • Optionaltransition?: TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                                                                                  Custom transition options for modal background / glasspane.

                                                                                                                                                                                                                                                                                                                                                  -

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +TJSDialogModalOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TJSDialogModalOptions

                                                                                                                                                                                                                                                                                                                                                TJSDialogModalOptions: {
                                                                                                                                                                                                                                                                                                                                                    background?: string;
                                                                                                                                                                                                                                                                                                                                                    closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                                                                                    slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                                                                                    styles?: { [key: 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?: { [key: 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 2d3ed8d..05106cf 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogOptions.html +++ b/docs/types/_runtime_svelte_application.TJSDialogOptions.html @@ -1,27 +1,27 @@ -TJSDialogOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias TJSDialogOptions

                                                                                                                                                                                                                                                                                                                                                TJSDialogOptions: {
                                                                                                                                                                                                                                                                                                                                                    buttons?: {
                                                                                                                                                                                                                                                                                                                                                        [key: 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?: {
                                                                                                                                                                                                                                                                                                                                                      [key: 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 +TJSDialogOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                  +

                                                                                                                                                                                                                                                                                                                                                  Type Alias TJSDialogOptions

                                                                                                                                                                                                                                                                                                                                                  TJSDialogOptions: {
                                                                                                                                                                                                                                                                                                                                                      buttons?: { [key: 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?: { [key: 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.

                                                                                                                                                                                                                                                                                                                                                    -
                                                                                                                                                                                                                                                                                                                                                  • OptionalrejectClose?: 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.

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

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

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

                                                                                                                                                                                                                                                                                                                                                  • 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
                                                                                                                                                                                                                                                                                                                                                  \ 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 802cf50..8be4ece 100644 --- a/docs/types/_runtime_svelte_application.TJSDialogTransitionOptions.html +++ b/docs/types/_runtime_svelte_application.TJSDialogTransitionOptions.html @@ -1,8 +1,8 @@ -TJSDialogTransitionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                                                                                TJSDialogTransitionOptions: {
                                                                                                                                                                                                                                                                                                                                                    inTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                    inTransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                    outTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                    outTransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                    transition?: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                    transitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                • OptionalinTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                                                                                  A Svelte transition applied to the in transition.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • OptionalinTransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Additional transition options applied to the in transition.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                • OptionaloutTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                                                                                  A Svelte transition applied to tbe out transition.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • OptionaloutTransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Additional transition options applied to the out transition.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                • Optionaltransition?: TransitionFunction

                                                                                                                                                                                                                                                                                                                                                  A Svelte transition function applied to both in / out transitions.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                • OptionaltransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                      [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                  }

                                                                                                                                                                                                                                                                                                                                                  Additional transition options applied to both in / out transitions.

                                                                                                                                                                                                                                                                                                                                                  -
                                                                                                                                                                                                                                                                                                                                                  • [key: string]: any

                                                                                                                                                                                                                                                                                                                                                Settings

                                                                                                                                                                                                                                                                                                                                                Member Visibility
                                                                                                                                                                                                                                                                                                                                                \ No newline at end of file +TJSDialogTransitionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                +

                                                                                                                                                                                                                                                                                                                                                Type Alias TJSDialogTransitionOptions

                                                                                                                                                                                                                                                                                                                                                TJSDialogTransitionOptions: {
                                                                                                                                                                                                                                                                                                                                                    inTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                    inTransitionOptions?: { [key: string]: any };
                                                                                                                                                                                                                                                                                                                                                    outTransition?: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                    outTransitionOptions?: { [key: string]: any };
                                                                                                                                                                                                                                                                                                                                                    transition?: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                    transitionOptions?: { [key: string]: any };
                                                                                                                                                                                                                                                                                                                                                }

                                                                                                                                                                                                                                                                                                                                                Type declaration

                                                                                                                                                                                                                                                                                                                                                • OptionalinTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                                                                                  A Svelte transition applied to the in transition.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • OptionalinTransitionOptions?: { [key: string]: any }

                                                                                                                                                                                                                                                                                                                                                  Additional transition options applied to the in transition.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • OptionaloutTransition?: TransitionFunction

                                                                                                                                                                                                                                                                                                                                                  A Svelte transition applied to tbe out transition.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • OptionaloutTransitionOptions?: { [key: string]: any }

                                                                                                                                                                                                                                                                                                                                                  Additional transition options applied to the out transition.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • Optionaltransition?: TransitionFunction

                                                                                                                                                                                                                                                                                                                                                  A Svelte transition function applied to both in / out transitions.

                                                                                                                                                                                                                                                                                                                                                  +
                                                                                                                                                                                                                                                                                                                                                • OptionaltransitionOptions?: { [key: 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_application.ApplicationShell-1.Events.html b/docs/types/_runtime_svelte_component_application.ApplicationShell-1.Events.html deleted file mode 100644 index e23fb6d..0000000 --- a/docs/types/_runtime_svelte_component_application.ApplicationShell-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.ApplicationShell-1.Props.html b/docs/types/_runtime_svelte_component_application.ApplicationShell-1.Props.html deleted file mode 100644 index c272ff7..0000000 --- a/docs/types/_runtime_svelte_component_application.ApplicationShell-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.ApplicationShell-1.Slots.html b/docs/types/_runtime_svelte_component_application.ApplicationShell-1.Slots.html deleted file mode 100644 index 93cd298..0000000 --- a/docs/types/_runtime_svelte_component_application.ApplicationShell-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.EmptyApplicationShell-1.Events.html b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell-1.Events.html deleted file mode 100644 index a3392e0..0000000 --- a/docs/types/_runtime_svelte_component_application.EmptyApplicationShell-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.EmptyApplicationShell-1.Props.html b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell-1.Props.html deleted file mode 100644 index cfee5f5..0000000 --- a/docs/types/_runtime_svelte_component_application.EmptyApplicationShell-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.EmptyApplicationShell-1.Slots.html b/docs/types/_runtime_svelte_component_application.EmptyApplicationShell-1.Slots.html deleted file mode 100644 index 9f76aaf..0000000 --- a/docs/types/_runtime_svelte_component_application.EmptyApplicationShell-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.TJSApplicationShell-1.Events.html b/docs/types/_runtime_svelte_component_application.TJSApplicationShell-1.Events.html deleted file mode 100644 index 332afa3..0000000 --- a/docs/types/_runtime_svelte_component_application.TJSApplicationShell-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.TJSApplicationShell-1.Props.html b/docs/types/_runtime_svelte_component_application.TJSApplicationShell-1.Props.html deleted file mode 100644 index 2f3d5ee..0000000 --- a/docs/types/_runtime_svelte_component_application.TJSApplicationShell-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.TJSApplicationShell-1.Slots.html b/docs/types/_runtime_svelte_component_application.TJSApplicationShell-1.Slots.html deleted file mode 100644 index 2b2f4b4..0000000 --- a/docs/types/_runtime_svelte_component_application.TJSApplicationShell-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.TJSGlassPane-1.Events.html b/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Events.html deleted file mode 100644 index 2d6986d..0000000 --- a/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                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_application.TJSGlassPane-1.Props.html b/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Props.html deleted file mode 100644 index 815d26b..0000000 --- a/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Props.html +++ /dev/null @@ -1,4 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                -

                                                                                                                                                                                                                                                                                                                                                Type Alias Props

                                                                                                                                                                                                                                                                                                                                                Props: {
                                                                                                                                                                                                                                                                                                                                                    background?: string;
                                                                                                                                                                                                                                                                                                                                                    captureInput?: boolean;
                                                                                                                                                                                                                                                                                                                                                    closeOnInput?: boolean;
                                                                                                                                                                                                                                                                                                                                                    id?: string;
                                                                                                                                                                                                                                                                                                                                                    inTransition?: any;
                                                                                                                                                                                                                                                                                                                                                    inTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                                                                    outTransition?: any;
                                                                                                                                                                                                                                                                                                                                                    outTransitionOptions?: {};
                                                                                                                                                                                                                                                                                                                                                    slotSeparate?: boolean;
                                                                                                                                                                                                                                                                                                                                                    styles?: {
                                                                                                                                                                                                                                                                                                                                                        [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                    };
                                                                                                                                                                                                                                                                                                                                                    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?: {
                                                                                                                                                                                                                                                                                                                                                          [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      • [key: string]: string | null
                                                                                                                                                                                                                                                                                                                                                    • Optionaltransition?: any
                                                                                                                                                                                                                                                                                                                                                    • OptionaltransitionOptions?: any
                                                                                                                                                                                                                                                                                                                                                    • OptionalzIndex?: number

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Slots.html b/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Slots.html deleted file mode 100644 index 0c3a7c5..0000000 --- a/docs/types/_runtime_svelte_component_application.TJSGlassPane-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 030237d..7331bc0 100644 --- a/docs/types/_runtime_svelte_easing.EasingFunctionName.html +++ b/docs/types/_runtime_svelte_easing.EasingFunctionName.html @@ -1,3 +1,3 @@ -EasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +EasingFunctionName | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 5919931..8c76e3b 100644 --- a/docs/types/_runtime_svelte_easing.EasingReference.html +++ b/docs/types/_runtime_svelte_easing.EasingReference.html @@ -1,3 +1,3 @@ -EasingReference | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +EasingReference | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_store_dom_input.KeyStoreOptions.html b/docs/types/_runtime_svelte_store_dom_input.KeyStoreOptions.html index 2bdc2ab..60d5b3d 100644 --- a/docs/types/_runtime_svelte_store_dom_input.KeyStoreOptions.html +++ b/docs/types/_runtime_svelte_store_dom_input.KeyStoreOptions.html @@ -1,5 +1,5 @@ -KeyStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +KeyStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 8453279..b423ea3 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionOptions.html @@ -1,6 +1,6 @@ -TJSDocumentCollectionOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSDocumentCollectionOptions

                                                                                                                                                                                                                                                                                                                                                    TJSDocumentCollectionOptions: {
                                                                                                                                                                                                                                                                                                                                                        delete?: ((collection: DocumentCollection) => void) | null;
                                                                                                                                                                                                                                                                                                                                                        preDelete?: ((collection: DocumentCollection) => void) | null;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    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 6a35cea..5227b46 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionUpdateOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentCollectionUpdateOptions.html @@ -1,7 +1,7 @@ -TJSDocumentCollectionUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • documents: T[]

                                                                                                                                                                                                                                                                                                                                                      associated documents that changed.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • documentType: string

                                                                                                                                                                                                                                                                                                                                                      The document name.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSDocumentCollectionUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSDocumentCollectionUpdateOptions<T>

                                                                                                                                                                                                                                                                                                                                                    TJSDocumentCollectionUpdateOptions: {
                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • documents: T[]

                                                                                                                                                                                                                                                                                                                                                      associated documents that changed.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • 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 723e3f3..8991341 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentOptions.html @@ -1,6 +1,6 @@ -TJSDocumentOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSDocumentOptions

                                                                                                                                                                                                                                                                                                                                                    TJSDocumentOptions: {
                                                                                                                                                                                                                                                                                                                                                        delete?: ((doc?: object) => void) | null;
                                                                                                                                                                                                                                                                                                                                                        preDelete?: ((doc?: object) => void) | null;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionaldelete?: ((doc?: object) => void) | null

                                                                                                                                                                                                                                                                                                                                                      Optional post delete function to invoke when +TJSDocumentOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSDocumentOptions

                                                                                                                                                                                                                                                                                                                                                      TJSDocumentOptions: {
                                                                                                                                                                                                                                                                                                                                                          delete?: (doc?: object) => void | null;
                                                                                                                                                                                                                                                                                                                                                          preDelete?: (doc?: object) => void | null;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionaldelete?: (doc?: object) => void | null

                                                                                                                                                                                                                                                                                                                                                        Optional post delete function to invoke when document is deleted after subscribers have been notified.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpreDelete?: ((doc?: object) => void) | null

                                                                                                                                                                                                                                                                                                                                                        Optional pre delete function to invoke +

                                                                                                                                                                                                                                                                                                                                                      • OptionalpreDelete?: (doc?: object) => void | null

                                                                                                                                                                                                                                                                                                                                                        Optional pre delete function to invoke when document is deleted before subscribers are notified.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    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 60d68ea..9c046d3 100644 --- a/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentUpdateOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_document.TJSDocumentUpdateOptions.html @@ -1,6 +1,6 @@ -TJSDocumentUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSDocumentUpdateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 fe14685..a2ecb7c 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.GameSetting.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.GameSetting.html @@ -1,8 +1,8 @@ -GameSetting | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalstore?: Writable<any>

                                                                                                                                                                                                                                                                                                                                                      An existing store instance to use.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +GameSetting | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • 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 977740b..7cb77f5 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingData.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingData.html @@ -1,3 +1,3 @@ -GameSettingData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias GameSettingData

                                                                                                                                                                                                                                                                                                                                                    GameSettingData: GameSettingOptions

                                                                                                                                                                                                                                                                                                                                                    Stores the primary TJS game setting keys w/ GameSettingOptions.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +GameSettingData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 62cfe2e..46633de 100644 --- a/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingOptions.html +++ b/docs/types/_runtime_svelte_store_fvtt_settings.GameSettingOptions.html @@ -1,14 +1,14 @@ -GameSettingOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +GameSettingOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalrange?: {
                                                                                                                                                                                                                                                                                                                                                            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
                                                                                                                                                                                                                                                                                                                                                      • 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
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                    • 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
                                                                                                                                                                                                                                                                                                                                                    \ 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 6756fc5..7970f9d 100644 --- a/docs/types/_runtime_svelte_store_position.Action.DraggableOptions.html +++ b/docs/types/_runtime_svelte_store_position.Action.DraggableOptions.html @@ -1,12 +1,12 @@ -DraggableOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    • Optionalbutton?: number

                                                                                                                                                                                                                                                                                                                                                      MouseEvent button that activates dragging; default: 0

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      See

                                                                                                                                                                                                                                                                                                                                                      https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • enabled: 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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • position: TJSPosition | Positionable

                                                                                                                                                                                                                                                                                                                                                      A position or positionable instance.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalstoreDragging?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                      A writable store that tracks "dragging" state.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionaltween?: boolean

                                                                                                                                                                                                                                                                                                                                                      When true tweening is enabled; default: false

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionaltweenOptions?: QuickTweenOptions

                                                                                                                                                                                                                                                                                                                                                      Quick tween options.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DraggableOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    • Optionalbutton?: number

                                                                                                                                                                                                                                                                                                                                                      MouseEvent button that activates dragging; default: 0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      See

                                                                                                                                                                                                                                                                                                                                                      https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/button

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • enabled: 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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • position: TJSPosition | Positionable

                                                                                                                                                                                                                                                                                                                                                      A position or positionable instance.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • OptionalstoreDragging?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                      A writable store that tracks "dragging" state.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionaltween?: boolean

                                                                                                                                                                                                                                                                                                                                                      When true tweening is enabled; default: false

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • OptionaltweenOptions?: QuickTweenOptions

                                                                                                                                                                                                                                                                                                                                                      Quick tween options.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index be3008d..0000000 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.AnimationKey.html +++ /dev/null @@ -1,3 +0,0 @@ -AnimationKey | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 9c1f858..0000000 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.GroupCallbackOptions.html +++ /dev/null @@ -1,7 +0,0 @@ -GroupCallbackOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ 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 deleted file mode 100644 index 0ca83df..0000000 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.QuickTweenOptions.html +++ /dev/null @@ -1,6 +0,0 @@ -QuickTweenOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index b535781..0000000 --- a/docs/types/_runtime_svelte_store_position.AnimationAPI-1.ScheduleOptions.html +++ /dev/null @@ -1,5 +0,0 @@ -ScheduleOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.Data.TJSPositionDataRelative.html b/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html index c7493a1..c974713 100644 --- a/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html +++ b/docs/types/_runtime_svelte_store_position.Data.TJSPositionDataRelative.html @@ -1,6 +1,6 @@ -TJSPositionDataRelative | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSPositionDataRelative | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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:

                                                                                                                                                                                                                                                                                                                                                    @@ -8,5 +8,5 @@

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +ValidatorAPI.ValidationData as the rest property allowing extra data to be sent to any custom validator.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 0780363..8bd4566 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtor.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtor.html @@ -1,7 +1,7 @@ -OptionsCtor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +OptionsCtor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ 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 71a58d7..7eef481 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtorAll.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsCtorAll.html @@ -1,4 +1,4 @@ -OptionsCtorAll | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ 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 9084690..593451f 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsGet.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsGet.html @@ -1,7 +1,7 @@ -OptionsGet | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +OptionsGet | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 258e0a9..b6e6178 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.OptionsSet.html @@ -1,6 +1,6 @@ -OptionsSet | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +OptionsSet | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                                      \ 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 bc6ab48..22749cd 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionGroup.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionGroup.html @@ -1,3 +1,3 @@ -PositionGroup | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +PositionGroup | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 1eafe19..6ffaf69 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionInitial.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionInitial.html @@ -1,5 +1,5 @@ -PositionInitial | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +PositionInitial | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 6066a59..178d959 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionParent.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionParent.html @@ -1,4 +1,4 @@ -PositionParent | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ 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 e35d92a..4b9a9eb 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionValidators.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.PositionValidators.html @@ -1,6 +1,6 @@ -PositionValidators | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias PositionValidators

                                                                                                                                                                                                                                                                                                                                                    PositionValidators: {
                                                                                                                                                                                                                                                                                                                                                        TransformBounds: ValidatorSystemConstructor;
                                                                                                                                                                                                                                                                                                                                                        transformWindow: ValidatorSystem;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Provides the default System.Initial.ValidatorSystem implementations available.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    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 0699800..ca38e6b 100644 --- a/docs/types/_runtime_svelte_store_position.TJSPositionTypes.Stores.html +++ b/docs/types/_runtime_svelte_store_position.TJSPositionTypes.Stores.html @@ -1,32 +1,32 @@ -Stores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +Stores | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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.

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

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • minHeight: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                      Derived store for minHeight updates.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • minWidth: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                      Derived store for minWidth updates.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • resizeContentHeight: Readable<number | undefined>

                                                                                                                                                                                                                                                                                                                                                      Readable store for contentHeight.

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

                                                                                                                                                                                                                                                                                                                                                      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.

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

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • minHeight: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for minHeight updates.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • minWidth: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for minWidth updates.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • resizeContentHeight: Readable<number | undefined>

                                                                                                                                                                                                                                                                                                                                                        Readable store for contentHeight.

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • rotateY: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for rotateY updates.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • rotateZ: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for rotateZ updates.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • scale: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for scale updates.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • top: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for top updates.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • transform: Readable<TransformData>

                                                                                                                                                                                                                                                                                                                                                        Readable store for transform data.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • transformOrigin: TransformOriginWritable

                                                                                                                                                                                                                                                                                                                                                        Derived store for transformOrigin updates.

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • zIndex: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                        Derived store for zIndex updates.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                  • 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.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • rotateY: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                    Derived store for rotateY updates.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • rotateZ: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                    Derived store for rotateZ updates.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • scale: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                    Derived store for scale updates.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • top: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                    Derived store for top updates.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • transform: Readable<TransformData>

                                                                                                                                                                                                                                                                                                                                                    Readable store for transform data.

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • transformOrigin: TransformOriginWritable

                                                                                                                                                                                                                                                                                                                                                    Derived store for transformOrigin updates.

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

                                                                                                                                                                                                                                                                                                                                                    +
                                                                                                                                                                                                                                                                                                                                                  • zIndex: Writable<number | null>

                                                                                                                                                                                                                                                                                                                                                    Derived store for zIndex updates.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    • 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 deleted file mode 100644 index bae243c..0000000 --- a/docs/types/_runtime_svelte_store_position.TransformAPI-1.TransformOrigin.html +++ /dev/null @@ -1,3 +0,0 @@ -TransformOrigin | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 0752215..0000000 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.RemoveByCallback.html +++ /dev/null @@ -1,4 +0,0 @@ -RemoveByCallback | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ 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 deleted file mode 100644 index fb83279..0000000 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidationData.html +++ /dev/null @@ -1,18 +0,0 @@ -ValidationData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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: {
                                                                                                                                                                                                                                                                                                                                                            [key: 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

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • marginLeft: number | undefined

                                                                                                                                                                                                                                                                                                                                                      Current left margin.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • marginTop: number | undefined

                                                                                                                                                                                                                                                                                                                                                      Current top margin.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • maxHeight: number | undefined

                                                                                                                                                                                                                                                                                                                                                      Current max height.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • maxWidth: number | undefined

                                                                                                                                                                                                                                                                                                                                                      Current max width.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • minHeight: number | undefined

                                                                                                                                                                                                                                                                                                                                                      Current min height.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • minWidth: number | undefined

                                                                                                                                                                                                                                                                                                                                                      Current min width.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • parent: PositionParent

                                                                                                                                                                                                                                                                                                                                                      Associated position parent instance.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • position: TJSPositionData

                                                                                                                                                                                                                                                                                                                                                      New position data to evaluate.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • rest: {
                                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                      } | undefined

                                                                                                                                                                                                                                                                                                                                                      The rest of any data submitted to TJSPosition.set. This may be used to provide directives to -validators.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • transforms: TransformAPI

                                                                                                                                                                                                                                                                                                                                                      Current applies transforms / transform tracking & conversion utility.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • width: number

                                                                                                                                                                                                                                                                                                                                                      Current width

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 92f5939..0000000 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorData.html +++ /dev/null @@ -1,10 +0,0 @@ -ValidatorData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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

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

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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
                                                                                                                                                                                                                                                                                                                                                    \ 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 deleted file mode 100644 index 60799c0..0000000 --- a/docs/types/_runtime_svelte_store_position.ValidatorAPI-1.ValidatorOption.html +++ /dev/null @@ -1,3 +0,0 @@ -ValidatorOption | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 51826f0..ef2aa86 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynArrayData.html +++ b/docs/types/_runtime_svelte_store_reducer.DynArrayData.html @@ -1,4 +1,4 @@ -DynArrayData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +DynArrayData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynArrayData<T>

                                                                                                                                                                                                                                                                                                                                                    DynArrayData: { 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 e18d7c6..2512893 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynCompareFn.html +++ b/docs/types/_runtime_svelte_store_reducer.DynCompareFn.html @@ -1,9 +1,9 @@ -DynCompareFn | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +DynCompareFn | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynCompareFn<T>

                                                                                                                                                                                                                                                                                                                                                    DynCompareFn: {
                                                                                                                                                                                                                                                                                                                                                        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

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

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      • (a: T, b: T): number

                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                        • a: T

                                                                                                                                                                                                                                                                                                                                                          Element 'a' of backing data to sort.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • b: T

                                                                                                                                                                                                                                                                                                                                                          Element 'b' of backing data to sort.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                        Returns number

                                                                                                                                                                                                                                                                                                                                                    • Optionalsubscribe?: (indexUpdate: DynIndexerUpdateFn) => () => void

                                                                                                                                                                                                                                                                                                                                                      Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    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 972baf2..495867c 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataArrayCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataArrayCreate.html @@ -1,5 +1,5 @@ -DynDataArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataArrayCreate<T>: {
                                                                                                                                                                                                                                                                                                                                                        ctor?: DynArrayReducerCtor<T>;
                                                                                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                                                                                    } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                                                    Defines object / options for creating a dynamic array reducer.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalctor?: DynArrayReducerCtor<T>

                                                                                                                                                                                                                                                                                                                                                      A DynMapReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalname?: string

                                                                                                                                                                                                                                                                                                                                                      Name of dynamic array reducer.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DynDataArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataArrayCreate: { ctor?: DynArrayReducerCtor<T>; name?: string } & DynDataOptions<
                                                                                                                                                                                                                                                                                                                                                        T,
                                                                                                                                                                                                                                                                                                                                                    >

                                                                                                                                                                                                                                                                                                                                                    Defines object / options for creating a dynamic array reducer.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalctor?: DynArrayReducerCtor<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 8466e85..2b64fb0 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataDerivedCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataDerivedCreate.html @@ -1,5 +1,5 @@ -DynDataDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataDerivedCreate<T>: {
                                                                                                                                                                                                                                                                                                                                                        ctor?: DynDerivedReducerCtor<T>;
                                                                                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                                                                                    } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                                                    Defines object / options for creating a derived reducer.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalctor?: DynDerivedReducerCtor<T>

                                                                                                                                                                                                                                                                                                                                                      A DerivedReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalname?: string

                                                                                                                                                                                                                                                                                                                                                      Name of derived reducer.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DynDataDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataDerivedCreate: { ctor?: DynDerivedReducerCtor<T>; name?: string } & DynDataOptions<
                                                                                                                                                                                                                                                                                                                                                        T,
                                                                                                                                                                                                                                                                                                                                                    >

                                                                                                                                                                                                                                                                                                                                                    Defines object / options for creating a derived reducer.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalctor?: DynDerivedReducerCtor<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 e68a38a..dbc4980 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataFilter.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataFilter.html @@ -1,7 +1,7 @@ -DynDataFilter | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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 +DynDataFilter | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataFilter<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataFilter: {
                                                                                                                                                                                                                                                                                                                                                        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.

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

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • 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 852b456..b047c93 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataHost.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataHost.html @@ -1,3 +1,3 @@ -DynDataHost | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +DynDataHost | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataHost<D>

                                                                                                                                                                                                                                                                                                                                                    DynDataHost: (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 e7db3b9..1c37322 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataMapCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataMapCreate.html @@ -1,5 +1,5 @@ -DynDataMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                                                    DynDataMapCreate<K, T>: {
                                                                                                                                                                                                                                                                                                                                                        ctor?: DynMapReducerCtor<K, T>;
                                                                                                                                                                                                                                                                                                                                                        name?: string;
                                                                                                                                                                                                                                                                                                                                                    } & DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                                                    Defines object / options for creating a dynamic map reducer.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • K
                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalctor?: DynMapReducerCtor<K, T>

                                                                                                                                                                                                                                                                                                                                                      A DynMapReducer constructor function / class.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalname?: string

                                                                                                                                                                                                                                                                                                                                                      Name of dynamic map reducer.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DynDataMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                                                    DynDataMapCreate: { ctor?: DynMapReducerCtor<K, T>; name?: string } & DynDataOptions<
                                                                                                                                                                                                                                                                                                                                                        T,
                                                                                                                                                                                                                                                                                                                                                    >

                                                                                                                                                                                                                                                                                                                                                    Defines object / options for creating a dynamic map reducer.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • K
                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalctor?: DynMapReducerCtor<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 66c0006..340a6d3 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataOptions.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataOptions.html @@ -1,5 +1,5 @@ -DynDataOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +DynDataOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataOptions<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataOptions: {
                                                                                                                                                                                                                                                                                                                                                        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 ab54f15..f76298f 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynDataSort.html +++ b/docs/types/_runtime_svelte_store_reducer.DynDataSort.html @@ -1,5 +1,5 @@ -DynDataSort | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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 +DynDataSort | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynDataSort<T>

                                                                                                                                                                                                                                                                                                                                                    DynDataSort: {
                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionalsubscribe?: (indexUpdate: DynIndexerUpdateFn) => () => void

                                                                                                                                                                                                                                                                                                                                                      Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    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 8f169c6..9d44638 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynFilterFn.html +++ b/docs/types/_runtime_svelte_store_reducer.DynFilterFn.html @@ -1,9 +1,8 @@ -DynFilterFn | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    +DynFilterFn | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynFilterFn<T>

                                                                                                                                                                                                                                                                                                                                                    DynFilterFn: {
                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                          Type Parameters

                                                                                                                                                                                                                                                                                                                                                          • T

                                                                                                                                                                                                                                                                                                                                                          Type declaration

                                                                                                                                                                                                                                                                                                                                                            • (element: T): boolean

                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                              • element: T

                                                                                                                                                                                                                                                                                                                                                                Element of backing data structure to filter.

                                                                                                                                                                                                                                                                                                                                                              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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                  • Optionalsubscribe?: (indexUpdate: DynIndexerUpdateFn) => () => void

                                                                                                                                                                                                                                                                                                                                                    Optional subscribe function following the Svelte store / subscribe pattern.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    • 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 200dacd..5f060ea 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynIndexerUpdateFn.html +++ b/docs/types/_runtime_svelte_store_reducer.DynIndexerUpdateFn.html @@ -1,4 +1,4 @@ -DynIndexerUpdateFn | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +DynIndexerUpdateFn | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynIndexerUpdateFn

                                                                                                                                                                                                                                                                                                                                                    DynIndexerUpdateFn: (force?: boolean) => void

                                                                                                                                                                                                                                                                                                                                                    Updates associated dynamic reducer indexer.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      • (force?: boolean): 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 16369ae..956d647 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynMapData.html +++ b/docs/types/_runtime_svelte_store_reducer.DynMapData.html @@ -1,4 +1,4 @@ -DynMapData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +DynMapData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynMapData<K, T>

                                                                                                                                                                                                                                                                                                                                                    DynMapData: { 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 e0cfdec..f83386f 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynOptionsArrayCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynOptionsArrayCreate.html @@ -1,2 +1,2 @@ -DynOptionsArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynOptionsArrayCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynOptionsArrayCreate<T>: string | DynArrayReducerCtor<T> | DynDataArrayCreate<T>

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DynOptionsArrayCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynOptionsArrayCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynOptionsArrayCreate: string | DynArrayReducerCtor<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 4c4833a..1c5b1e3 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynOptionsDerivedCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynOptionsDerivedCreate.html @@ -1,3 +1,3 @@ -DynOptionsDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynOptionsDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynOptionsDerivedCreate<T>: string | DynDerivedReducerCtor<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 +DynOptionsDerivedCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynOptionsDerivedCreate<T>

                                                                                                                                                                                                                                                                                                                                                    DynOptionsDerivedCreate:
                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                        | DynDerivedReducerCtor<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 05694ee..e7c8c85 100644 --- a/docs/types/_runtime_svelte_store_reducer.DynOptionsMapCreate.html +++ b/docs/types/_runtime_svelte_store_reducer.DynOptionsMapCreate.html @@ -1,2 +1,2 @@ -DynOptionsMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynOptionsMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                                                    DynOptionsMapCreate<K, T>: string | DynMapReducerCtor<K, T> | DynDataMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • K
                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DynOptionsMapCreate | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias DynOptionsMapCreate<K, T>

                                                                                                                                                                                                                                                                                                                                                    DynOptionsMapCreate: string | DynMapReducerCtor<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 deleted file mode 100644 index 674bf6a..0000000 --- a/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectStoreParams.html +++ /dev/null @@ -1,11 +0,0 @@ -ArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionaldataReducer?: boolean

                                                                                                                                                                                                                                                                                                                                                      When true a DynArrayReducer will be instantiated wrapping store -data and accessible from ArrayObjectStore.dataReducer.

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

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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 deleted file mode 100644 index aa0136a..0000000 --- a/docs/types/_runtime_svelte_store_reducer_array_object.ArrayObjectUpdateData.html +++ /dev/null @@ -1,2 +0,0 @@ -ArrayObjectUpdateData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 2f1f0d0..0000000 --- a/docs/types/_runtime_svelte_store_reducer_array_object.BaseArrayObjectEntryStore.html +++ /dev/null @@ -1,2 +0,0 @@ -BaseArrayObjectEntryStore | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index d66cb53..0000000 --- a/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParamProps.html +++ /dev/null @@ -1,8 +0,0 @@ -CrudArrayObjectStoreParamProps | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias CrudArrayObjectStoreParamProps

                                                                                                                                                                                                                                                                                                                                                    CrudArrayObjectStoreParamProps: {
                                                                                                                                                                                                                                                                                                                                                        crudDispatch?: CrudDispatch;
                                                                                                                                                                                                                                                                                                                                                        extraData?: object;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • OptionalcrudDispatch?: CrudDispatch
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalextraData?: object
                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • -
                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index c1dc3c9..0000000 --- a/docs/types/_runtime_svelte_store_reducer_array_object.CrudArrayObjectStoreParams.html +++ /dev/null @@ -1,2 +0,0 @@ -CrudArrayObjectStoreParams | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 13b4f8a..0000000 --- a/docs/types/_runtime_svelte_store_reducer_array_object.CrudDispatch.html +++ /dev/null @@ -1,4 +0,0 @@ -CrudDispatch | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 4641f48..0000000 --- a/docs/types/_runtime_svelte_store_web_storage.StorageDerived.html +++ /dev/null @@ -1,7 +0,0 @@ -StorageDerived | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • 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 deleted file mode 100644 index 09bb70a..0000000 --- a/docs/types/_runtime_svelte_store_web_storage.StorageReadable.html +++ /dev/null @@ -1,7 +0,0 @@ -StorageReadable | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias StorageReadable

                                                                                                                                                                                                                                                                                                                                                    StorageReadable: (<T>(key: string, value: T, start: StartStopNotifier<T>) => Readable<T>)

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      • <T>(key, value, start): Readable<T>

                                                                                                                                                                                                                                                                                                                                                      • Type Parameters

                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                          Creates a Readable store that allows reading by subscription.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                        • key: string

                                                                                                                                                                                                                                                                                                                                                          storage key

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • value: T

                                                                                                                                                                                                                                                                                                                                                          initial value

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • start: StartStopNotifier<T>

                                                                                                                                                                                                                                                                                                                                                          Start and stop notifications for subscriptions.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                        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 deleted file mode 100644 index fb6c304..0000000 --- a/docs/types/_runtime_svelte_store_web_storage.StorageStores.html +++ /dev/null @@ -1,4 +0,0 @@ -StorageStores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 39ac9e3..0000000 --- a/docs/types/_runtime_svelte_store_web_storage.StorageWritable.html +++ /dev/null @@ -1,7 +0,0 @@ -StorageWritable | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias StorageWritable

                                                                                                                                                                                                                                                                                                                                                    StorageWritable: (<T>(key: string, value: T, start?: StartStopNotifier<T>) => Writable<T>)

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      • <T>(key, value, start?): Writable<T>

                                                                                                                                                                                                                                                                                                                                                      • Type Parameters

                                                                                                                                                                                                                                                                                                                                                        • T

                                                                                                                                                                                                                                                                                                                                                          Create a Writable store that allows both updating and reading by subscription.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                        Parameters

                                                                                                                                                                                                                                                                                                                                                        • key: string

                                                                                                                                                                                                                                                                                                                                                          Storage key.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • value: T

                                                                                                                                                                                                                                                                                                                                                          Default value.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optionalstart: StartStopNotifier<T>

                                                                                                                                                                                                                                                                                                                                                          Start and stop notifications for subscriptions.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                        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.SetValues.html b/docs/types/_runtime_svelte_store_writable_derived.SetValues.html deleted file mode 100644 index d471238..0000000 --- a/docs/types/_runtime_svelte_store_writable_derived.SetValues.html +++ /dev/null @@ -1,3 +0,0 @@ -SetValues | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 1b3c374..0000000 --- a/docs/types/_runtime_svelte_store_writable_derived.Stores.html +++ /dev/null @@ -1,3 +0,0 @@ -Stores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 9f3c84e..0000000 --- a/docs/types/_runtime_svelte_store_writable_derived.StoresValues.html +++ /dev/null @@ -1,3 +0,0 @@ -StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 fc9dbb5..58e8062 100644 --- a/docs/types/_runtime_svelte_transition.TransitionFunction.html +++ b/docs/types/_runtime_svelte_transition.TransitionFunction.html @@ -1,3 +1,3 @@ -TransitionFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TransitionFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 b10e769..b71d223 100644 --- a/docs/types/_runtime_svelte_util.TJSSvelteConfig.html +++ b/docs/types/_runtime_svelte_util.TJSSvelteConfig.html @@ -1,11 +1,11 @@ -TJSSvelteConfig | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                    TJSSvelteConfig: {
                                                                                                                                                                                                                                                                                                                                                        anchor?: Element;
                                                                                                                                                                                                                                                                                                                                                        class: (new (options: ComponentConstructorOptions<Record<string, any>>) => SvelteComponent<any, any, any>);
                                                                                                                                                                                                                                                                                                                                                        context?: (() => {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                        } | Map<string, any>) | Map<string, any> | {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        hydrate?: boolean;
                                                                                                                                                                                                                                                                                                                                                        intro?: boolean;
                                                                                                                                                                                                                                                                                                                                                        props?: (() => {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                        }) | {
                                                                                                                                                                                                                                                                                                                                                            [key: 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?: (() => {
                                                                                                                                                                                                                                                                                                                                                          [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                      } | Map<string, any>) | Map<string, any> | {
                                                                                                                                                                                                                                                                                                                                                          [key: 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 +TJSSvelteConfig | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                      TJSSvelteConfig: {
                                                                                                                                                                                                                                                                                                                                                          anchor?: Element;
                                                                                                                                                                                                                                                                                                                                                          class: new (
                                                                                                                                                                                                                                                                                                                                                              options: ComponentConstructorOptions<Record<string, any>>,
                                                                                                                                                                                                                                                                                                                                                          ) => SvelteComponent<any, any, any>;
                                                                                                                                                                                                                                                                                                                                                          context?:
                                                                                                                                                                                                                                                                                                                                                              | () => { [key: string]: any } | Map<string, any>
                                                                                                                                                                                                                                                                                                                                                              | Map<string, any>
                                                                                                                                                                                                                                                                                                                                                              | { [key: string]: any };
                                                                                                                                                                                                                                                                                                                                                          hydrate?: boolean;
                                                                                                                                                                                                                                                                                                                                                          intro?: boolean;
                                                                                                                                                                                                                                                                                                                                                          props?: () => { [key: string]: any } | { [key: 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?:
                                                                                                                                                                                                                                                                                                                                                            | () => { [key: string]: any } | Map<string, any>
                                                                                                                                                                                                                                                                                                                                                            | Map<string, any>
                                                                                                                                                                                                                                                                                                                                                            | { [key: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalintro?: boolean

                                                                                                                                                                                                                                                                                                                                                        If true, will play transitions on initial render, rather than waiting for subsequent state changes.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalprops?: (() => {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                        }) | {
                                                                                                                                                                                                                                                                                                                                                            [key: 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 +
                                                                                                                                                                                                                                                                                                                                                    • Optionalintro?: boolean

                                                                                                                                                                                                                                                                                                                                                      If true, will play transitions on initial render, rather than waiting for subsequent state changes.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionalprops?: () => { [key: string]: any } | { [key: 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_a11y.A11yFocusSource.html b/docs/types/_runtime_util_a11y.A11yFocusSource.html index 9895a00..51197b7 100644 --- a/docs/types/_runtime_util_a11y.A11yFocusSource.html +++ b/docs/types/_runtime_util_a11y.A11yFocusSource.html @@ -1,9 +1,9 @@ -A11yFocusSource | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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

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

                                                                                                                                                                                                                                                                                                                                                    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_a11y.FocusableElement.html b/docs/types/_runtime_util_a11y.FocusableElement.html index e6b9d1c..ddd31f7 100644 --- a/docs/types/_runtime_util_a11y.FocusableElement.html +++ b/docs/types/_runtime_util_a11y.FocusableElement.html @@ -1,3 +1,3 @@ -FocusableElement | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias FocusableElement

                                                                                                                                                                                                                                                                                                                                                    FocusableElement: Element & HTMLOrSVGElement

                                                                                                                                                                                                                                                                                                                                                    A focusable element; either HTMLElement or SvgElement.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +FocusableElement | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_a11y.FocusableElementOptions.html b/docs/types/_runtime_util_a11y.FocusableElementOptions.html index b2ab98a..2954a00 100644 --- a/docs/types/_runtime_util_a11y.FocusableElementOptions.html +++ b/docs/types/_runtime_util_a11y.FocusableElementOptions.html @@ -1,10 +1,10 @@ -FocusableElementOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias FocusableElementOptions

                                                                                                                                                                                                                                                                                                                                                    FocusableElementOptions: {
                                                                                                                                                                                                                                                                                                                                                        anchorHref?: boolean;
                                                                                                                                                                                                                                                                                                                                                        ignoreClasses?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                                                        ignoreElements?: Set<Element>;
                                                                                                                                                                                                                                                                                                                                                        parentHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                                        selectors?: string;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Options for A11yHelper.getFirstFocusableElement, -A11yHelper.getFocusableElements, and A11yHelper.getLastFocusableElement.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • OptionalanchorHref?: boolean

                                                                                                                                                                                                                                                                                                                                                      When true anchors must have an HREF; default: true.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalignoreClasses?: Iterable<string>

                                                                                                                                                                                                                                                                                                                                                      Iterable list of classes to ignore elements.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalignoreElements?: Set<Element>

                                                                                                                                                                                                                                                                                                                                                      Set of elements to ignore.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalparentHidden?: boolean

                                                                                                                                                                                                                                                                                                                                                      When true elements with hidden parents will be removed; +FocusableElementOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias FocusableElementOptions

                                                                                                                                                                                                                                                                                                                                                      FocusableElementOptions: {
                                                                                                                                                                                                                                                                                                                                                          anchorHref?: boolean;
                                                                                                                                                                                                                                                                                                                                                          ignoreClasses?: Iterable<string>;
                                                                                                                                                                                                                                                                                                                                                          ignoreElements?: Set<Element>;
                                                                                                                                                                                                                                                                                                                                                          parentHidden?: boolean;
                                                                                                                                                                                                                                                                                                                                                          selectors?: string;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Options for A11yHelper.getFirstFocusableElement, +A11yHelper.getFocusableElements, and A11yHelper.getLastFocusableElement.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • OptionalanchorHref?: boolean

                                                                                                                                                                                                                                                                                                                                                        When true anchors must have an HREF; default: true.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalignoreClasses?: Iterable<string>

                                                                                                                                                                                                                                                                                                                                                        Iterable list of classes to ignore elements.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalignoreElements?: Set<Element>

                                                                                                                                                                                                                                                                                                                                                        Set of elements to ignore.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalparentHidden?: boolean

                                                                                                                                                                                                                                                                                                                                                        When true elements with hidden parents will be removed; default: false.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalselectors?: string

                                                                                                                                                                                                                                                                                                                                                        Custom list of focusable selectors for querySelectorAll.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                    • Optionalselectors?: string

                                                                                                                                                                                                                                                                                                                                                      Custom list of focusable selectors for querySelectorAll.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ 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 4c21459..47da10f 100644 --- a/docs/types/_runtime_util_animate.BasicAnimationState.html +++ b/docs/types/_runtime_util_animate.BasicAnimationState.html @@ -1,4 +1,4 @@ -BasicAnimationState | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +BasicAnimationState | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_runtime_util_dom_input_tinykeys.KeyBindingPress.html b/docs/types/_runtime_util_dom_input_tinykeys.KeyBindingPress.html index 533f107..cdc47f0 100644 --- a/docs/types/_runtime_util_dom_input_tinykeys.KeyBindingPress.html +++ b/docs/types/_runtime_util_dom_input_tinykeys.KeyBindingPress.html @@ -1,3 +1,3 @@ -KeyBindingPress | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias KeyBindingPress

                                                                                                                                                                                                                                                                                                                                                    KeyBindingPress: [mods: string[], key: string | RegExp]

                                                                                                                                                                                                                                                                                                                                                    A single press of a keybinding sequence

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +KeyBindingPress | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias KeyBindingPress

                                                                                                                                                                                                                                                                                                                                                    KeyBindingPress: [mods: string[], key: string | RegExp]

                                                                                                                                                                                                                                                                                                                                                    A single press of a keybinding sequence

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_runtime_util_dom_layout.StackingContext.html b/docs/types/_runtime_util_dom_layout.StackingContext.html index 6a33bf7..0264a89 100644 --- a/docs/types/_runtime_util_dom_layout.StackingContext.html +++ b/docs/types/_runtime_util_dom_layout.StackingContext.html @@ -1,8 +1,8 @@ -StackingContext | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_dom_observer.ResizeObserverData.ResizeFunction.html b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeFunction.html index 7dbdc6c..e6a4423 100644 --- a/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeFunction.html +++ b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeFunction.html @@ -1,3 +1,3 @@ -ResizeFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +ResizeFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_dom_observer.ResizeObserverData.ResizeObject.html b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeObject.html index da5629d..80fa91a 100644 --- a/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeObject.html +++ b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeObject.html @@ -1,7 +1,7 @@ -ResizeObject | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +ResizeObject | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_dom_observer.ResizeObserverData.ResizeObjectExtended.html b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeObjectExtended.html index d899db6..f7a33f1 100644 --- a/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeObjectExtended.html +++ b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeObjectExtended.html @@ -1,7 +1,7 @@ -ResizeObjectExtended | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +ResizeObjectExtended | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • OptionalsetDimension?: (offsetWidth: number, offsetHeight: number) => unknown

                                                                                                                                                                                                                                                                                                                                                      A function that is invoked with offset width & height changes.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • 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_dom_observer.ResizeObserverData.ResizeTarget.html b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeTarget.html index 96e1862..1d223e0 100644 --- a/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeTarget.html +++ b/docs/types/_runtime_util_dom_observer.ResizeObserverData.ResizeTarget.html @@ -1,4 +1,4 @@ -ResizeTarget | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias ResizeTarget

                                                                                                                                                                                                                                                                                                                                                    ResizeTarget: ResizeObject | ResizeObjectExtended | ResizeFunction

                                                                                                                                                                                                                                                                                                                                                    The receiving target for observed resize data associated with ResizeObserverManager. Just one of the +ResizeTarget | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index f9476d3..0000000 --- a/docs/types/_runtime_util_loader_module.ModuleLoaderObj.html +++ /dev/null @@ -1,12 +0,0 @@ -ModuleLoaderObj | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 -selects.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • isESM: boolean

                                                                                                                                                                                                                                                                                                                                                      Indicates if the import was an ES Module.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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
                                                                                                                                                                                                                                                                                                                                                    \ 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 f942370..b827a78 100644 --- a/docs/types/_runtime_util_object.JSONValue.html +++ b/docs/types/_runtime_util_object.JSONValue.html @@ -1,2 +1,2 @@ -JSONValue | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias JSONValue

                                                                                                                                                                                                                                                                                                                                                    JSONValue: Primitive | JSONObject | JSONArray

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +JSONValue | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 c20eadc..4e7a793 100644 --- a/docs/types/_runtime_util_object.Primitive.html +++ b/docs/types/_runtime_util_object.Primitive.html @@ -1,2 +1,2 @@ -Primitive | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Primitive

                                                                                                                                                                                                                                                                                                                                                    Primitive:
                                                                                                                                                                                                                                                                                                                                                        | bigint
                                                                                                                                                                                                                                                                                                                                                        | boolean
                                                                                                                                                                                                                                                                                                                                                        | null
                                                                                                                                                                                                                                                                                                                                                        | number
                                                                                                                                                                                                                                                                                                                                                        | string
                                                                                                                                                                                                                                                                                                                                                        | symbol
                                                                                                                                                                                                                                                                                                                                                        | undefined

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Primitive | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 f22f856..5e27f57 100644 --- a/docs/types/_runtime_util_object.SafeSetOperation.html +++ b/docs/types/_runtime_util_object.SafeSetOperation.html @@ -1,3 +1,3 @@ -SafeSetOperation | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +SafeSetOperation | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 893fb99..4a99d39 100644 --- a/docs/types/_runtime_util_object.ValidationEntry.html +++ b/docs/types/_runtime_util_object.ValidationEntry.html @@ -1,9 +1,9 @@ -ValidationEntry | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionaltype?: string

                                                                                                                                                                                                                                                                                                                                                      Optionally tests with a typeof check.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +ValidationEntry | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionaltype?: string

                                                                                                                                                                                                                                                                                                                                                      Optionally tests with a typeof check.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_action_animate_composable.ComposableActionOptions.AnimateWAAPI.html b/docs/types/_standard_action_animate_composable.ComposableActionOptions.AnimateWAAPI.html index b009831..148d88d 100644 --- a/docs/types/_standard_action_animate_composable.ComposableActionOptions.AnimateWAAPI.html +++ b/docs/types/_standard_action_animate_composable.ComposableActionOptions.AnimateWAAPI.html @@ -1,15 +1,15 @@ -AnimateWAAPI | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias AnimateWAAPI

                                                                                                                                                                                                                                                                                                                                                    AnimateWAAPI: {
                                                                                                                                                                                                                                                                                                                                                        debounce?: number;
                                                                                                                                                                                                                                                                                                                                                        duration?: number;
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                        event?: keyof HTMLElementEventMap;
                                                                                                                                                                                                                                                                                                                                                        keyframeOptions?: KeyframeAnimationOptions;
                                                                                                                                                                                                                                                                                                                                                        keyframes: Keyframe[] | PropertyIndexedKeyframes;
                                                                                                                                                                                                                                                                                                                                                        strategy?: "cancel" | "exclusive";
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Defines the options for the animateWAAPI action.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionaldebounce?: number

                                                                                                                                                                                                                                                                                                                                                      Add a debounce to incoming events in milliseconds. Consider using the exclusive strategy.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalduration?: number

                                                                                                                                                                                                                                                                                                                                                      Duration in milliseconds. Default value: 600.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                      Is the animation enabled. Default value: true.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalevent?: keyof HTMLElementEventMap

                                                                                                                                                                                                                                                                                                                                                      DOM event name to bind element to respond with the WAAPI animation. Default value: click.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalkeyframeOptions?: KeyframeAnimationOptions

                                                                                                                                                                                                                                                                                                                                                      An object containing one or more timing properties. When defined it is used instead of duration.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • keyframes: Keyframe[] | PropertyIndexedKeyframes

                                                                                                                                                                                                                                                                                                                                                      An array of keyframe objects or a keyframe object whose properties are arrays of values to iterate over.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalstrategy?: "cancel" | "exclusive"

                                                                                                                                                                                                                                                                                                                                                      The scheduling strategy to take. cancel to cancel any current animation, exclusive to skip scheduling an +AnimateWAAPI | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias AnimateWAAPI

                                                                                                                                                                                                                                                                                                                                                      AnimateWAAPI: {
                                                                                                                                                                                                                                                                                                                                                          debounce?: number;
                                                                                                                                                                                                                                                                                                                                                          duration?: number;
                                                                                                                                                                                                                                                                                                                                                          enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                          event?: keyof HTMLElementEventMap;
                                                                                                                                                                                                                                                                                                                                                          keyframeOptions?: KeyframeAnimationOptions;
                                                                                                                                                                                                                                                                                                                                                          keyframes: Keyframe[] | PropertyIndexedKeyframes;
                                                                                                                                                                                                                                                                                                                                                          strategy?: "cancel" | "exclusive";
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Defines the options for the animateWAAPI action.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionaldebounce?: number

                                                                                                                                                                                                                                                                                                                                                        Add a debounce to incoming events in milliseconds. Consider using the exclusive strategy.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalduration?: number

                                                                                                                                                                                                                                                                                                                                                        Duration in milliseconds. Default value: 600.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                        Is the animation enabled. Default value: true.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalevent?: keyof HTMLElementEventMap

                                                                                                                                                                                                                                                                                                                                                        DOM event name to bind element to respond with the WAAPI animation. Default value: click.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalkeyframeOptions?: KeyframeAnimationOptions

                                                                                                                                                                                                                                                                                                                                                        An object containing one or more timing properties. When defined it is used instead of duration.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • keyframes: Keyframe[] | PropertyIndexedKeyframes

                                                                                                                                                                                                                                                                                                                                                        An array of keyframe objects or a keyframe object whose properties are arrays of values to iterate over.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalstrategy?: "cancel" | "exclusive"

                                                                                                                                                                                                                                                                                                                                                        The scheduling strategy to take. cancel to cancel any current animation, exclusive to skip scheduling an animation if one is currently running. Default value: cancel.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                      See

                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                    See

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_action_animate_composable.ComposableActionOptions.Ripple.html b/docs/types/_standard_action_animate_composable.ComposableActionOptions.Ripple.html index 6fceb5a..aa0e2da 100644 --- a/docs/types/_standard_action_animate_composable.ComposableActionOptions.Ripple.html +++ b/docs/types/_standard_action_animate_composable.ComposableActionOptions.Ripple.html @@ -1,4 +1,4 @@ -Ripple | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Ripple

                                                                                                                                                                                                                                                                                                                                                    Ripple: {
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Defines the options for the ripple action.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                      Is the animation enabled. Default value: true.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Ripple | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Ripple

                                                                                                                                                                                                                                                                                                                                                    Ripple: { enabled?: boolean }

                                                                                                                                                                                                                                                                                                                                                    Defines the options for the ripple action.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                      Is the animation enabled. Default value: true.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_action_animate_composable.ComposableActionOptions.RippleFocus.html b/docs/types/_standard_action_animate_composable.ComposableActionOptions.RippleFocus.html index 8112680..e373891 100644 --- a/docs/types/_standard_action_animate_composable.ComposableActionOptions.RippleFocus.html +++ b/docs/types/_standard_action_animate_composable.ComposableActionOptions.RippleFocus.html @@ -1,4 +1,4 @@ -RippleFocus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias RippleFocus

                                                                                                                                                                                                                                                                                                                                                    RippleFocus: {
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Defines the options for the rippleFocus action.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                      Is the animation enabled. Default value: true.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +RippleFocus | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias RippleFocus

                                                                                                                                                                                                                                                                                                                                                    RippleFocus: { enabled?: boolean }

                                                                                                                                                                                                                                                                                                                                                    Defines the options for the rippleFocus action.

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                      Is the animation enabled. Default value: true.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_application_control_filepicker.FVTTFilePickerBrowseOptions.html b/docs/types/_standard_application_control_filepicker.FVTTFilePickerBrowseOptions.html index 0cf1f04..9996917 100644 --- a/docs/types/_standard_application_control_filepicker.FVTTFilePickerBrowseOptions.html +++ b/docs/types/_standard_application_control_filepicker.FVTTFilePickerBrowseOptions.html @@ -1,27 +1,27 @@ -FVTTFilePickerBrowseOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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: {
                                                                                                                                                                                                                                                                                                                                                                [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                            transitionOptions: {
                                                                                                                                                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        onURLString?: (({ urlString: string }: any) => void);
                                                                                                                                                                                                                                                                                                                                                        onValidateURLString?: (({ urlString: string }: any) => Promise<boolean>);
                                                                                                                                                                                                                                                                                                                                                        redirectToRoot?: string[];
                                                                                                                                                                                                                                                                                                                                                        store?: MinimalWritable<string>;
                                                                                                                                                                                                                                                                                                                                                        tileSize?: boolean;
                                                                                                                                                                                                                                                                                                                                                        type?: string;
                                                                                                                                                                                                                                                                                                                                                        zIndex?: number;
                                                                                                                                                                                                                                                                                                                                                    }
                                                                                                                                                                                                                                                                                                                                                      +FVTTFilePickerBrowseOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                              transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                              transitionOptions: { [key: string]: any };
                                                                                                                                                                                                                                                                                                                                                          };
                                                                                                                                                                                                                                                                                                                                                          onURLString?: ({ urlString: string }: any) => void;
                                                                                                                                                                                                                                                                                                                                                          onValidateURLString?: ({ urlString: string }: any) => Promise<boolean>;
                                                                                                                                                                                                                                                                                                                                                          redirectToRoot?: string[];
                                                                                                                                                                                                                                                                                                                                                          store?: MinimalWritable<string>;
                                                                                                                                                                                                                                                                                                                                                          tileSize?: boolean;
                                                                                                                                                                                                                                                                                                                                                          type?: string;
                                                                                                                                                                                                                                                                                                                                                          zIndex?: number;
                                                                                                                                                                                                                                                                                                                                                      }
                                                                                                                                                                                                                                                                                                                                                      • Foundry globalThis.FilePicker w/ expanded FVTTFilePickerControl options.
                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                      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: {
                                                                                                                                                                                                                                                                                                                                                                [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                            transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                            transitionOptions: {
                                                                                                                                                                                                                                                                                                                                                                [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                            };
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Options for the modal glasspane / TJSGlasspane component.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        • background: string
                                                                                                                                                                                                                                                                                                                                                        • closeOnInput: boolean
                                                                                                                                                                                                                                                                                                                                                        • styles: {
                                                                                                                                                                                                                                                                                                                                                              [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                          • [key: string]: string | null
                                                                                                                                                                                                                                                                                                                                                        • transition: TransitionFunction
                                                                                                                                                                                                                                                                                                                                                        • transitionOptions: {
                                                                                                                                                                                                                                                                                                                                                              [key: string]: any;
                                                                                                                                                                                                                                                                                                                                                          }
                                                                                                                                                                                                                                                                                                                                                          • [key: string]: any
                                                                                                                                                                                                                                                                                                                                                      • OptionalonURLString?: (({ urlString: string }: any) => void)

                                                                                                                                                                                                                                                                                                                                                        Optional function invoked when URL string changes.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                          • ({ urlString: string }): void

                                                                                                                                                                                                                                                                                                                                                          • Parameters

                                                                                                                                                                                                                                                                                                                                                            • { urlString: string }: any

                                                                                                                                                                                                                                                                                                                                                            Returns void

                                                                                                                                                                                                                                                                                                                                                      • OptionalonValidateURLString?: (({ urlString: string }: any) => Promise<boolean>)

                                                                                                                                                                                                                                                                                                                                                        Optional validation function of +

                                                                                                                                                                                                                                                                                                                                                        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: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                              transition: TransitionFunction;
                                                                                                                                                                                                                                                                                                                                                              transitionOptions: { [key: string]: any };
                                                                                                                                                                                                                                                                                                                                                          }

                                                                                                                                                                                                                                                                                                                                                          Options for the modal glasspane / TJSGlasspane component.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • OptionalonURLString?: ({ urlString: string }: any) => void

                                                                                                                                                                                                                                                                                                                                                          Optional function invoked when URL string changes.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • OptionalonValidateURLString?: ({ urlString: string }: any) => Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                          Optional validation function of selected URL string.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                            • ({ urlString: string }): Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                            • Parameters

                                                                                                                                                                                                                                                                                                                                                              • { urlString: string }: any

                                                                                                                                                                                                                                                                                                                                                              Returns Promise<boolean>

                                                                                                                                                                                                                                                                                                                                                        • OptionalredirectToRoot?: string[]

                                                                                                                                                                                                                                                                                                                                                          Redirect to the root directory rather than starting in the source directory +

                                                                                                                                                                                                                                                                                                                                                        • OptionalredirectToRoot?: string[]

                                                                                                                                                                                                                                                                                                                                                          Redirect to the root directory rather than starting in the source directory of one of these files.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optionalstore?: MinimalWritable<string>

                                                                                                                                                                                                                                                                                                                                                          A minimal writable store that is +

                                                                                                                                                                                                                                                                                                                                                        • Optionalstore?: MinimalWritable<string>

                                                                                                                                                                                                                                                                                                                                                          A minimal writable 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', +

                                                                                                                                                                                                                                                                                                                                                        • 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 +
                                                                                                                                                                                                                                                                                                                                                  • 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_control_sidebar.FVTTSidebarAddData.html b/docs/types/_standard_application_control_sidebar.FVTTSidebarAddData.html index a4123af..fae30a8 100644 --- a/docs/types/_standard_application_control_sidebar.FVTTSidebarAddData.html +++ b/docs/types/_standard_application_control_sidebar.FVTTSidebarAddData.html @@ -1,19 +1,19 @@ -FVTTSidebarAddData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +FVTTSidebarAddData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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:

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalcondition?: 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 +

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalmergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                                                        Provides a custom base implementation for the object instance +

                                                                                                                                                                                                                                                                                                                                                      • id: string

                                                                                                                                                                                                                                                                                                                                                        The unique Sidebar ID / name. Used for CSS ID and retrieving the sidebar.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalmergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                                                        Provides a custom base implementation for the object instance for this sidebar app stored in globalThis.ui.<SIDEBAR ID>.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpopoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                                                        Provides a custom +

                                                                                                                                                                                                                                                                                                                                                      • OptionalpopoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                                                        Provides a custom SvelteApplication class to instantiate for the popout sidebar.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpopoutOptions?: object

                                                                                                                                                                                                                                                                                                                                                        Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • svelte: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                        A Svelte configuration object.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • 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 +
                                                                                                                                                                                                                                                                                                                                                    • OptionalpopoutOptions?: object

                                                                                                                                                                                                                                                                                                                                                      Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • svelte: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                      A Svelte configuration object.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • 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_control_sidebar.FVTTSidebarEntry.html b/docs/types/_standard_application_control_sidebar.FVTTSidebarEntry.html index d571e58..e7baa23 100644 --- a/docs/types/_standard_application_control_sidebar.FVTTSidebarEntry.html +++ b/docs/types/_standard_application_control_sidebar.FVTTSidebarEntry.html @@ -1,7 +1,7 @@ -FVTTSidebarEntry | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_control_sidebar.FVTTSidebarRemoveData.html b/docs/types/_standard_application_control_sidebar.FVTTSidebarRemoveData.html index 5a5db99..327134e 100644 --- a/docs/types/_standard_application_control_sidebar.FVTTSidebarRemoveData.html +++ b/docs/types/_standard_application_control_sidebar.FVTTSidebarRemoveData.html @@ -1,5 +1,5 @@ -FVTTSidebarRemoveData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +FVTTSidebarRemoveData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                    • id: string

                                                                                                                                                                                                                                                                                                                                                      The ID for the sidebar tab to remove. This must be an existing sidebar tab ID.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_application_control_sidebar.FVTTSidebarReplaceData.html b/docs/types/_standard_application_control_sidebar.FVTTSidebarReplaceData.html index 310bc25..4a3565c 100644 --- a/docs/types/_standard_application_control_sidebar.FVTTSidebarReplaceData.html +++ b/docs/types/_standard_application_control_sidebar.FVTTSidebarReplaceData.html @@ -1,16 +1,16 @@ -FVTTSidebarReplaceData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +FVTTSidebarReplaceData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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 +

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalmergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                                                        Provides a custom base implementation for the object instance for this sidebar +

                                                                                                                                                                                                                                                                                                                                                      • id: string

                                                                                                                                                                                                                                                                                                                                                        The ID for the sidebar to replace. This must be an existing sidebar tab ID.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalmergeAppImpl?: object

                                                                                                                                                                                                                                                                                                                                                        Provides a custom base implementation for the object instance for this sidebar app stored in globalThis.ui.<SIDEBAR ID>.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpopoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                                                        Provides a custom +

                                                                                                                                                                                                                                                                                                                                                      • OptionalpopoutApplication?: SvelteApplication

                                                                                                                                                                                                                                                                                                                                                        Provides a custom SvelteApplication class to instantiate for the popout sidebar.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpopoutOptions?: object

                                                                                                                                                                                                                                                                                                                                                        Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • svelte: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                        A Svelte configuration object.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • 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 +
                                                                                                                                                                                                                                                                                                                                                    • OptionalpopoutOptions?: object

                                                                                                                                                                                                                                                                                                                                                      Provides SvelteApplication options overrides for the default popout sidebar.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • svelte: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                      A Svelte configuration object.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • 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_menu.TJSContextMenuItemData.html b/docs/types/_standard_application_menu.TJSContextMenuItemData.html index 38cdf8c..d2e0deb 100644 --- a/docs/types/_standard_application_menu.TJSContextMenuItemData.html +++ b/docs/types/_standard_application_menu.TJSContextMenuItemData.html @@ -1,17 +1,17 @@ -TJSContextMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSContextMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    • Optionalclass?: Function

                                                                                                                                                                                                                                                                                                                                                      A Svelte component class.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalcondition?: 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.

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

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • 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 +
                                                                                                                                                                                                                                                                                                                                                  • 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_button.TJSIconButton-1.Events.html b/docs/types/_standard_component_button.TJSIconButton-1.Events.html deleted file mode 100644 index 1ac40d3..0000000 --- a/docs/types/_standard_component_button.TJSIconButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_button.TJSIconButton-1.Props.html b/docs/types/_standard_component_button.TJSIconButton-1.Props.html deleted file mode 100644 index 4bcbfaf..0000000 --- a/docs/types/_standard_component_button.TJSIconButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: any;
                                                                                                                                                                                                                                                                                                                                                        clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_button.TJSIconButton-1.Slots.html b/docs/types/_standard_component_button.TJSIconButton-1.Slots.html deleted file mode 100644 index 28f7436..0000000 --- a/docs/types/_standard_component_button.TJSIconButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_button.TJSSlotButton-1.Events.html b/docs/types/_standard_component_button.TJSSlotButton-1.Events.html deleted file mode 100644 index dab2e80..0000000 --- a/docs/types/_standard_component_button.TJSSlotButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_button.TJSSlotButton-1.Props.html b/docs/types/_standard_component_button.TJSSlotButton-1.Props.html deleted file mode 100644 index 530b741..0000000 --- a/docs/types/_standard_component_button.TJSSlotButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: any;
                                                                                                                                                                                                                                                                                                                                                        clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_button.TJSSlotButton-1.Slots.html b/docs/types/_standard_component_button.TJSSlotButton-1.Slots.html deleted file mode 100644 index 0e8c8f7..0000000 --- a/docs/types/_standard_component_button.TJSSlotButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_button.TJSToggleIconButton-1.Events.html b/docs/types/_standard_component_button.TJSToggleIconButton-1.Events.html deleted file mode 100644 index b52d11b..0000000 --- a/docs/types/_standard_component_button.TJSToggleIconButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_button.TJSToggleIconButton-1.Props.html b/docs/types/_standard_component_button.TJSToggleIconButton-1.Props.html deleted file mode 100644 index 786548c..0000000 --- a/docs/types/_standard_component_button.TJSToggleIconButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: any;
                                                                                                                                                                                                                                                                                                                                                        clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_button.TJSToggleIconButton-1.Slots.html b/docs/types/_standard_component_button.TJSToggleIconButton-1.Slots.html deleted file mode 100644 index d26253f..0000000 --- a/docs/types/_standard_component_button.TJSToggleIconButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_color_picker_colord.TJSColordButton-1.Events.html b/docs/types/_standard_component_color_picker_colord.TJSColordButton-1.Events.html deleted file mode 100644 index e720927..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_color_picker_colord.TJSColordButton-1.Props.html b/docs/types/_standard_component_color_picker_colord.TJSColordButton-1.Props.html deleted file mode 100644 index 0287cb1..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: any;
                                                                                                                                                                                                                                                                                                                                                        clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                        color?: any;
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_color_picker_colord.TJSColordButton-1.Slots.html b/docs/types/_standard_component_color_picker_colord.TJSColordButton-1.Slots.html deleted file mode 100644 index 402180c..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_color_picker_colord.TJSColordPicker-1.Events.html b/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Events.html deleted file mode 100644 index a40f754..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_color_picker_colord.TJSColordPicker-1.Props.html b/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Props.html deleted file mode 100644 index 8ddf83b..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Props.html +++ /dev/null @@ -1,7 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        color?: TJSColordPickerColor;
                                                                                                                                                                                                                                                                                                                                                        options?: TJSColordPickerOptions;
                                                                                                                                                                                                                                                                                                                                                        webStorage?: WebStorage;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalcolor?: TJSColordPickerColor

                                                                                                                                                                                                                                                                                                                                                      color properties

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionaloptions?: TJSColordPickerOptions

                                                                                                                                                                                                                                                                                                                                                      User settable options / customization properties.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalwebStorage?: WebStorage

                                                                                                                                                                                                                                                                                                                                                      External shared WebStorage instance. By assigning an external WebStorage instance you can share state like -the saved colors plugin across color picker instances.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Slots.html b/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Slots.html deleted file mode 100644 index 65c35b5..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordPicker-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_color_picker_colord.TJSColordPickerColor.html b/docs/types/_standard_component_color_picker_colord.TJSColordPickerColor.html deleted file mode 100644 index c8d3e3c..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordPickerColor.html +++ /dev/null @@ -1,2 +0,0 @@ -TJSColordPickerColor | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSColordPickerColor

                                                                                                                                                                                                                                                                                                                                                    TJSColordPickerColor: object | string

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_color_picker_colord.TJSColordPickerComponents.html b/docs/types/_standard_component_color_picker_colord.TJSColordPickerComponents.html deleted file mode 100644 index e9d181b..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordPickerComponents.html +++ /dev/null @@ -1,11 +0,0 @@ -TJSColordPickerComponents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_color_picker_colord.TJSColordPickerOptions.html b/docs/types/_standard_component_color_picker_colord.TJSColordPickerOptions.html deleted file mode 100644 index 41c5635..0000000 --- a/docs/types/_standard_component_color_picker_colord.TJSColordPickerOptions.html +++ /dev/null @@ -1,22 +0,0 @@ -TJSColordPickerOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSColordPickerOptions

                                                                                                                                                                                                                                                                                                                                                    TJSColordPickerOptions: {
                                                                                                                                                                                                                                                                                                                                                        addons?: Iterable<Function>;
                                                                                                                                                                                                                                                                                                                                                        components?: TJSColordPickerComponents;
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                        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?: MinimalWritable<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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean

                                                                                                                                                                                                                                                                                                                                                      Enable state of the color picker input.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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?: MinimalWritable<TJSColordPickerColor>

                                                                                                                                                                                                                                                                                                                                                      An external minimal -writable 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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_container.TJSScrollContainer-1.Events.html b/docs/types/_standard_component_container.TJSScrollContainer-1.Events.html deleted file mode 100644 index 7faa355..0000000 --- a/docs/types/_standard_component_container.TJSScrollContainer-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_container.TJSScrollContainer-1.Props.html b/docs/types/_standard_component_container.TJSScrollContainer-1.Props.html deleted file mode 100644 index 8978da2..0000000 --- a/docs/types/_standard_component_container.TJSScrollContainer-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        container?: TJSScrollContainerData;
                                                                                                                                                                                                                                                                                                                                                        scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                        styles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_container.TJSScrollContainer-1.Slots.html b/docs/types/_standard_component_container.TJSScrollContainer-1.Slots.html deleted file mode 100644 index cca203a..0000000 --- a/docs/types/_standard_component_container.TJSScrollContainer-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_container.TJSScrollContainerData.html b/docs/types/_standard_component_container.TJSScrollContainerData.html index 5bf45dd..1e5345d 100644 --- a/docs/types/_standard_component_container.TJSScrollContainerData.html +++ b/docs/types/_standard_component_container.TJSScrollContainerData.html @@ -1,9 +1,9 @@ -TJSScrollContainerData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSScrollContainerData

                                                                                                                                                                                                                                                                                                                                                    TJSScrollContainerData: {
                                                                                                                                                                                                                                                                                                                                                        class?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                                        props?: object;
                                                                                                                                                                                                                                                                                                                                                        scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                        styles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalclass?: SvelteComponent

                                                                                                                                                                                                                                                                                                                                                      A svelte component class used as the content component when +TJSScrollContainerData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSScrollContainerData

                                                                                                                                                                                                                                                                                                                                                      TJSScrollContainerData: {
                                                                                                                                                                                                                                                                                                                                                          class?: SvelteComponent;
                                                                                                                                                                                                                                                                                                                                                          props?: object;
                                                                                                                                                                                                                                                                                                                                                          scrollTop?: Writable<number>;
                                                                                                                                                                                                                                                                                                                                                          styles?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionalclass?: SvelteComponent

                                                                                                                                                                                                                                                                                                                                                        A svelte component class used as the content component when there is no slotted component defined.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalprops?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalscrollTop?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Inline styles to assign to the container.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        • [key: string]: string | null

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +
                                                                                                                                                                                                                                                                                                                                                    • Optionalstyles?: { [key: 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_dom_focus.TJSFocusWrap-1.Events.html b/docs/types/_standard_component_dom_focus.TJSFocusWrap-1.Events.html deleted file mode 100644 index 4757265..0000000 --- a/docs/types/_standard_component_dom_focus.TJSFocusWrap-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_dom_focus.TJSFocusWrap-1.Props.html b/docs/types/_standard_component_dom_focus.TJSFocusWrap-1.Props.html deleted file mode 100644 index 11a33dc..0000000 --- a/docs/types/_standard_component_dom_focus.TJSFocusWrap-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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/_standard_component_dom_focus.TJSFocusWrap-1.Slots.html b/docs/types/_standard_component_dom_focus.TJSFocusWrap-1.Slots.html deleted file mode 100644 index 36499d1..0000000 --- a/docs/types/_standard_component_dom_focus.TJSFocusWrap-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_folder.TJSFolderData.html b/docs/types/_standard_component_folder.TJSFolderData.html index 3391e14..acd6b81 100644 --- a/docs/types/_standard_component_folder.TJSFolderData.html +++ b/docs/types/_standard_component_folder.TJSFolderData.html @@ -1,24 +1,24 @@ -TJSFolderData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSFolderData

                                                                                                                                                                                                                                                                                                                                                    TJSFolderData: {
                                                                                                                                                                                                                                                                                                                                                        enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                    • Optionalenabled?: boolean
                                                                                                                                                                                                                                                                                                                                                        +TJSFolderData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                        +

                                                                                                                                                                                                                                                                                                                                                        Type Alias TJSFolderData

                                                                                                                                                                                                                                                                                                                                                        TJSFolderData: {
                                                                                                                                                                                                                                                                                                                                                            enabled?: boolean;
                                                                                                                                                                                                                                                                                                                                                            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

                                                                                                                                                                                                                                                                                                                                                        • Optionalenabled?: boolean
                                                                                                                                                                                                                                                                                                                                                          • Enabled state.
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optionalid?: string
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                        • Optionalid?: string
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                                          Defines the key event code to open / close summary when focused.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optionallabel?: string
                                                                                                                                                                                                                                                                                                                                                            +
                                                                                                                                                                                                                                                                                                                                                        • OptionalkeyCode?: string

                                                                                                                                                                                                                                                                                                                                                          Defines the key event code to open / close summary when focused.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • Optionallabel?: string
                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • 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 +

                                                                                                                                                                                                                                                                                                                                                        • OptionalonClose?: () => void

                                                                                                                                                                                                                                                                                                                                                          Callback when folder closed.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • OptionalonContextMenu?: (event?: MouseEvent) => void

                                                                                                                                                                                                                                                                                                                                                          Callback for context menu.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • OptionalonOpen?: () => void

                                                                                                                                                                                                                                                                                                                                                          Callback when folder opened.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • Optionaloptions?: TJSFolderOptions

                                                                                                                                                                                                                                                                                                                                                          Additional folder options.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • OptionalslotDefault?: { class: Function; props?: object }

                                                                                                                                                                                                                                                                                                                                                          A minimal Svelte config defining the default content component.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • OptionalslotLabel?: {
                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • OptionalslotSummaryEnd?: {
                                                                                                                                                                                                                                                                                                                                                              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.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optionalstore?: Writable<boolean>

                                                                                                                                                                                                                                                                                                                                                          Folder open / close store.

                                                                                                                                                                                                                                                                                                                                                          -
                                                                                                                                                                                                                                                                                                                                                        • Optionalstyles?: object

                                                                                                                                                                                                                                                                                                                                                          Additional styles to apply.

                                                                                                                                                                                                                                                                                                                                                          -

                                                                                                                                                                                                                                                                                                                                                        Settings

                                                                                                                                                                                                                                                                                                                                                        Member Visibility
                                                                                                                                                                                                                                                                                                                                                        \ 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_folder.TJSFolderOptions.html b/docs/types/_standard_component_folder.TJSFolderOptions.html index 3ba80c2..96b6b8f 100644 --- a/docs/types/_standard_component_folder.TJSFolderOptions.html +++ b/docs/types/_standard_component_folder.TJSFolderOptions.html @@ -1,7 +1,7 @@ -TJSFolderOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSFolderOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalfocusIndicator?: 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
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSIconFolder-1.Events.html b/docs/types/_standard_component_folder.TJSIconFolder-1.Events.html deleted file mode 100644 index 1e9ab3e..0000000 --- a/docs/types/_standard_component_folder.TJSIconFolder-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_folder.TJSIconFolder-1.Props.html b/docs/types/_standard_component_folder.TJSIconFolder-1.Props.html deleted file mode 100644 index 6662734..0000000 --- a/docs/types/_standard_component_folder.TJSIconFolder-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        animate?: boolean;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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?: MinimalWritable<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_folder.TJSIconFolder-1.Slots.html b/docs/types/_standard_component_folder.TJSIconFolder-1.Slots.html deleted file mode 100644 index 0650ba8..0000000 --- a/docs/types/_standard_component_folder.TJSIconFolder-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_folder.TJSIconFolderData.html b/docs/types/_standard_component_folder.TJSIconFolderData.html index ff2eb62..a84c87b 100644 --- a/docs/types/_standard_component_folder.TJSIconFolderData.html +++ b/docs/types/_standard_component_folder.TJSIconFolderData.html @@ -1,2 +1,2 @@ -TJSIconFolderData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSIconFolderData

                                                                                                                                                                                                                                                                                                                                                    TJSIconFolderData: TJSFolderData

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSIconFolderData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSIconFolderData

                                                                                                                                                                                                                                                                                                                                                    TJSIconFolderData: TJSFolderData

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_folder.TJSSvgFolder-1.Events.html b/docs/types/_standard_component_folder.TJSSvgFolder-1.Events.html deleted file mode 100644 index 3db3d00..0000000 --- a/docs/types/_standard_component_folder.TJSSvgFolder-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_folder.TJSSvgFolder-1.Props.html b/docs/types/_standard_component_folder.TJSSvgFolder-1.Props.html deleted file mode 100644 index 8d65d9a..0000000 --- a/docs/types/_standard_component_folder.TJSSvgFolder-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        animate?: boolean;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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?: MinimalWritable<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_folder.TJSSvgFolder-1.Slots.html b/docs/types/_standard_component_folder.TJSSvgFolder-1.Slots.html deleted file mode 100644 index 7f90204..0000000 --- a/docs/types/_standard_component_folder.TJSSvgFolder-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSButton-1.Events.html b/docs/types/_standard_component_form.TJSButton-1.Events.html deleted file mode 100644 index a6ad9a5..0000000 --- a/docs/types/_standard_component_form.TJSButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSButton-1.Props.html b/docs/types/_standard_component_form.TJSButton-1.Props.html deleted file mode 100644 index bd3e798..0000000 --- a/docs/types/_standard_component_form.TJSButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: any;
                                                                                                                                                                                                                                                                                                                                                        clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_form.TJSButton-1.Slots.html b/docs/types/_standard_component_form.TJSButton-1.Slots.html deleted file mode 100644 index 30bc76b..0000000 --- a/docs/types/_standard_component_form.TJSButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInput-1.Events.html b/docs/types/_standard_component_form.TJSInput-1.Events.html deleted file mode 100644 index 08e52e5..0000000 --- a/docs/types/_standard_component_form.TJSInput-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInput-1.Props.html b/docs/types/_standard_component_form.TJSInput-1.Props.html deleted file mode 100644 index d56fe90..0000000 --- a/docs/types/_standard_component_form.TJSInput-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInput-1.Slots.html b/docs/types/_standard_component_form.TJSInput-1.Slots.html deleted file mode 100644 index cfdab05..0000000 --- a/docs/types/_standard_component_form.TJSInput-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputCheckbox-1.Events.html b/docs/types/_standard_component_form.TJSInputCheckbox-1.Events.html deleted file mode 100644 index 756c77b..0000000 --- a/docs/types/_standard_component_form.TJSInputCheckbox-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputCheckbox-1.Props.html b/docs/types/_standard_component_form.TJSInputCheckbox-1.Props.html deleted file mode 100644 index 4ecc8be..0000000 --- a/docs/types/_standard_component_form.TJSInputCheckbox-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_form.TJSInputCheckbox-1.Slots.html b/docs/types/_standard_component_form.TJSInputCheckbox-1.Slots.html deleted file mode 100644 index 68eacc1..0000000 --- a/docs/types/_standard_component_form.TJSInputCheckbox-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputNumber-1.Events.html b/docs/types/_standard_component_form.TJSInputNumber-1.Events.html deleted file mode 100644 index f2709a1..0000000 --- a/docs/types/_standard_component_form.TJSInputNumber-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputNumber-1.Props.html b/docs/types/_standard_component_form.TJSInputNumber-1.Props.html deleted file mode 100644 index 1bd429c..0000000 --- a/docs/types/_standard_component_form.TJSInputNumber-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_form.TJSInputNumber-1.Slots.html b/docs/types/_standard_component_form.TJSInputNumber-1.Slots.html deleted file mode 100644 index 6bf9468..0000000 --- a/docs/types/_standard_component_form.TJSInputNumber-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputRange-1.Events.html b/docs/types/_standard_component_form.TJSInputRange-1.Events.html deleted file mode 100644 index 0074cb3..0000000 --- a/docs/types/_standard_component_form.TJSInputRange-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputRange-1.Props.html b/docs/types/_standard_component_form.TJSInputRange-1.Props.html deleted file mode 100644 index f0daa95..0000000 --- a/docs/types/_standard_component_form.TJSInputRange-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: any;
                                                                                                                                                                                                                                                                                                                                                        input?: any;
                                                                                                                                                                                                                                                                                                                                                        label?: any;
                                                                                                                                                                                                                                                                                                                                                        max?: any;
                                                                                                                                                                                                                                                                                                                                                        min?: any;
                                                                                                                                                                                                                                                                                                                                                        options?: any;
                                                                                                                                                                                                                                                                                                                                                        readonly?: any;
                                                                                                                                                                                                                                                                                                                                                        step?: 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_form.TJSInputRange-1.Slots.html b/docs/types/_standard_component_form.TJSInputRange-1.Slots.html deleted file mode 100644 index 5b15515..0000000 --- a/docs/types/_standard_component_form.TJSInputRange-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputRangeNumber-1.Events.html b/docs/types/_standard_component_form.TJSInputRangeNumber-1.Events.html deleted file mode 100644 index 27a0564..0000000 --- a/docs/types/_standard_component_form.TJSInputRangeNumber-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputRangeNumber-1.Props.html b/docs/types/_standard_component_form.TJSInputRangeNumber-1.Props.html deleted file mode 100644 index d6d4852..0000000 --- a/docs/types/_standard_component_form.TJSInputRangeNumber-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: any;
                                                                                                                                                                                                                                                                                                                                                        input?: any;
                                                                                                                                                                                                                                                                                                                                                        label?: any;
                                                                                                                                                                                                                                                                                                                                                        max?: any;
                                                                                                                                                                                                                                                                                                                                                        min?: any;
                                                                                                                                                                                                                                                                                                                                                        options?: any;
                                                                                                                                                                                                                                                                                                                                                        readonly?: any;
                                                                                                                                                                                                                                                                                                                                                        step?: 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_form.TJSInputRangeNumber-1.Slots.html b/docs/types/_standard_component_form.TJSInputRangeNumber-1.Slots.html deleted file mode 100644 index 050c2b6..0000000 --- a/docs/types/_standard_component_form.TJSInputRangeNumber-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputText-1.Events.html b/docs/types/_standard_component_form.TJSInputText-1.Events.html deleted file mode 100644 index 9ef1fd6..0000000 --- a/docs/types/_standard_component_form.TJSInputText-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSInputText-1.Props.html b/docs/types/_standard_component_form.TJSInputText-1.Props.html deleted file mode 100644 index 3db5d82..0000000 --- a/docs/types/_standard_component_form.TJSInputText-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_form.TJSInputText-1.Slots.html b/docs/types/_standard_component_form.TJSInputText-1.Slots.html deleted file mode 100644 index 19e9416..0000000 --- a/docs/types/_standard_component_form.TJSInputText-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSSelect-1.Events.html b/docs/types/_standard_component_form.TJSSelect-1.Events.html deleted file mode 100644 index 7839b5c..0000000 --- a/docs/types/_standard_component_form.TJSSelect-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_form.TJSSelect-1.Props.html b/docs/types/_standard_component_form.TJSSelect-1.Props.html deleted file mode 100644 index 7660ed8..0000000 --- a/docs/types/_standard_component_form.TJSSelect-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_form.TJSSelect-1.Slots.html b/docs/types/_standard_component_form.TJSSelect-1.Slots.html deleted file mode 100644 index f355ff1..0000000 --- a/docs/types/_standard_component_form.TJSSelect-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_editor.PMEditorExtra.html b/docs/types/_standard_component_fvtt_editor.PMEditorExtra.html index f26fad2..f04b131 100644 --- a/docs/types/_standard_component_fvtt_editor.PMEditorExtra.html +++ b/docs/types/_standard_component_fvtt_editor.PMEditorExtra.html @@ -1,4 +1,4 @@ -PMEditorExtra | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +PMEditorExtra | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Events.html b/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Events.html deleted file mode 100644 index 66b02ea..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_editor.TJSContentEdit-1.Props.html b/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Props.html deleted file mode 100644 index 712a499..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Props.html +++ /dev/null @@ -1,4 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_editor.TJSContentEdit-1.Slots.html b/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Slots.html deleted file mode 100644 index 2e28bef..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSContentEdit-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_editor.TJSContentEditOptions.html b/docs/types/_standard_component_fvtt_editor.TJSContentEditOptions.html index 2a24fb8..d3e3a61 100644 --- a/docs/types/_standard_component_fvtt_editor.TJSContentEditOptions.html +++ b/docs/types/_standard_component_fvtt_editor.TJSContentEditOptions.html @@ -1,27 +1,27 @@ -TJSContentEditOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSContentEditOptions

                                                                                                                                                                                                                                                                                                                                                    TJSContentEditOptions: {
                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                    • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                      Provides an edit button to start editing. When button is false editing is +TJSContentEditOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSContentEditOptions

                                                                                                                                                                                                                                                                                                                                                      TJSContentEditOptions: {
                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                      • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                        Provides an edit button to start editing. When button is false editing is always enabled.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalclasses?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalclickToEdit?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionaldocument?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionaleditable?: boolean

                                                                                                                                                                                                                                                                                                                                                        Prevents editing and hides button. When set to false any active editor +

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

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

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpreventEnterKey?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpreventPaste?: boolean

                                                                                                                                                                                                                                                                                                                                                        Prevents pasting content into the editor.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalsaveOnBlur?: 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.

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

                                                                                                                                                                                                                                                                                                                                                      • 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
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Events.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Events.html deleted file mode 100644 index 94a593e..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_editor.TJSProseMirror-1.Props.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Props.html deleted file mode 100644 index fdfce3b..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Props.html +++ /dev/null @@ -1,4 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_editor.TJSProseMirror-1.Slots.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Slots.html deleted file mode 100644 index 5940558..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSProseMirror-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_editor.TJSProseMirrorOptions.html b/docs/types/_standard_component_fvtt_editor.TJSProseMirrorOptions.html index 51416a0..608def9 100644 --- a/docs/types/_standard_component_fvtt_editor.TJSProseMirrorOptions.html +++ b/docs/types/_standard_component_fvtt_editor.TJSProseMirrorOptions.html @@ -1,23 +1,23 @@ -TJSProseMirrorOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSProseMirrorOptions

                                                                                                                                                                                                                                                                                                                                                    TJSProseMirrorOptions: {
                                                                                                                                                                                                                                                                                                                                                        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?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: globalThis.ProseMirror.Plugin;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        styles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                      Provides an edit button to start editing. When button is false editing is +TJSProseMirrorOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSProseMirrorOptions

                                                                                                                                                                                                                                                                                                                                                      TJSProseMirrorOptions: {
                                                                                                                                                                                                                                                                                                                                                          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?: { [key: string]: object };
                                                                                                                                                                                                                                                                                                                                                          styles?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Type declaration

                                                                                                                                                                                                                                                                                                                                                      • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                        Provides an edit button to start editing. When button is false editing is always enabled.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalclasses?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalclickToEdit?: 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.

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

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionaleditable?: boolean

                                                                                                                                                                                                                                                                                                                                                        Prevents editing and hides button. When set to false any active editor +

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • 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?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: globalThis.ProseMirror.Plugin;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Additional ProseMirror plugins to load.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        • [key: string]: globalThis.ProseMirror.Plugin
                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Additional CSS property names and values to set as inline +

                                                                                                                                                                                                                                                                                                                                                      • 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?: { [key: string]: object }

                                                                                                                                                                                                                                                                                                                                                        Additional ProseMirror plugins to load.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: { [key: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        • [key: string]: string | null

                                                                                                                                                                                                                                                                                                                                                      Settings

                                                                                                                                                                                                                                                                                                                                                      Member Visibility
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Events.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Events.html deleted file mode 100644 index 07b9c9e..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_editor.TJSTinyMCE-1.Props.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Props.html deleted file mode 100644 index b7367b2..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Props.html +++ /dev/null @@ -1,4 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_editor.TJSTinyMCE-1.Slots.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Slots.html deleted file mode 100644 index 8debfc2..0000000 --- a/docs/types/_standard_component_fvtt_editor.TJSTinyMCE-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_editor.TJSTinyMCEOptions.html b/docs/types/_standard_component_fvtt_editor.TJSTinyMCEOptions.html index 041a95c..226f26b 100644 --- a/docs/types/_standard_component_fvtt_editor.TJSTinyMCEOptions.html +++ b/docs/types/_standard_component_fvtt_editor.TJSTinyMCEOptions.html @@ -1,35 +1,35 @@ -TJSTinyMCEOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                                                                                    TJSTinyMCEOptions: {
                                                                                                                                                                                                                                                                                                                                                        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

                                                                                                                                                                                                                                                                                                                                                    • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                      Provides an edit button to start editing. When button is false editing is +TJSTinyMCEOptions | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      Type Alias TJSTinyMCEOptions

                                                                                                                                                                                                                                                                                                                                                      TJSTinyMCEOptions: {
                                                                                                                                                                                                                                                                                                                                                          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

                                                                                                                                                                                                                                                                                                                                                      • Optionalbutton?: boolean

                                                                                                                                                                                                                                                                                                                                                        Provides an edit button to start editing. When button is false editing is always enabled.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalclasses?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalclickToEdit?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionaldocument?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionaleditable?: boolean

                                                                                                                                                                                                                                                                                                                                                        Prevents editing and hides button. When set to false any active editor +

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

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

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

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

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalmceConfig?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpreventEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                                        When true this prevents enter key from creating a new line / +TinyMCEHelper.configStandard is used.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalpreventEnterKey?: boolean

                                                                                                                                                                                                                                                                                                                                                        When true this prevents enter key from creating a new line / paragraph.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalpreventPaste?: boolean

                                                                                                                                                                                                                                                                                                                                                        Prevents pasting content into the editor.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalsaveOnBlur?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalsaveOnEnterKey?: 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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                            [x: string]: string;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Additional CSS property names and values to set as inline styles. +refer to TinyMCEHelper.optionsSingleLine.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • 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
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Events.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Events.html deleted file mode 100644 index 738cab5..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Events

                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                        filepicker:urlString: 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_filepicker_button.TJSFileButton-1.Props.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Props.html deleted file mode 100644 index ea0cb7d..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: object;
                                                                                                                                                                                                                                                                                                                                                        pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                        urlString?: string;
                                                                                                                                                                                                                                                                                                                                                        [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_filepicker_button.TJSFileButton-1.Slots.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Slots.html deleted file mode 100644 index 492763b..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_filepicker_button.TJSFileIconButton-1.Events.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.Events.html deleted file mode 100644 index e6b2848..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Events

                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                        filepicker:urlString: 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_filepicker_button.TJSFileIconButton-1.Props.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.Props.html deleted file mode 100644 index a0a1c7c..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: object;
                                                                                                                                                                                                                                                                                                                                                        pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                        urlString?: string;
                                                                                                                                                                                                                                                                                                                                                        [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_filepicker_button.TJSFileIconButton-1.Slots.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.Slots.html deleted file mode 100644 index c5f01f6..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileIconButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_filepicker_button.TJSFileSlotButton-1.Events.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.Events.html deleted file mode 100644 index 9a70ba6..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Events

                                                                                                                                                                                                                                                                                                                                                    Events: {
                                                                                                                                                                                                                                                                                                                                                        filepicker:urlString: 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_filepicker_button.TJSFileSlotButton-1.Props.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.Props.html deleted file mode 100644 index c1f785a..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        button?: object;
                                                                                                                                                                                                                                                                                                                                                        pickerOptions?: FVTTFilePickerBrowseOptions;
                                                                                                                                                                                                                                                                                                                                                        urlString?: string;
                                                                                                                                                                                                                                                                                                                                                        [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_filepicker_button.TJSFileSlotButton-1.Slots.html b/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.Slots.html deleted file mode 100644 index b202f3e..0000000 --- a/docs/types/_standard_component_fvtt_filepicker_button.TJSFileSlotButton-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_settings.TJSSettingsEdit-1.Events.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit-1.Events.html deleted file mode 100644 index 2efd406..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_settings.TJSSettingsEdit-1.Props.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit-1.Props.html deleted file mode 100644 index 996f95e..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit-1.Props.html +++ /dev/null @@ -1,4 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        options?: TJSSettingsCreateOptions;
                                                                                                                                                                                                                                                                                                                                                        settings?: TJSGameSettingsWithUI;
                                                                                                                                                                                                                                                                                                                                                        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_fvtt_settings.TJSSettingsEdit-1.Slots.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit-1.Slots.html deleted file mode 100644 index 265eb8b..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSSettingsEdit-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_settings.TJSSettingsSwap-1.Events.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Events.html deleted file mode 100644 index dda2e38..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_settings.TJSSettingsSwap-1.Props.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Props.html deleted file mode 100644 index 06e2550..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        options?: TJSSettingsCreateOptions;
                                                                                                                                                                                                                                                                                                                                                        settings?: TJSGameSettingsWithUI;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Slots.html b/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Slots.html deleted file mode 100644 index d2e3067..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSSettingsSwap-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_settings.TJSThemeEditor-1.Events.html b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Events.html deleted file mode 100644 index f94fe0c..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_settings.TJSThemeEditor-1.Props.html b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Props.html deleted file mode 100644 index 9567883..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        themeStore?: any;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Slots.html b/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Slots.html deleted file mode 100644 index 52ac7bf..0000000 --- a/docs/types/_standard_component_fvtt_settings.TJSThemeEditor-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_label.TJSSlotLabel-1.Events.html b/docs/types/_standard_component_label.TJSSlotLabel-1.Events.html deleted file mode 100644 index 134a91a..0000000 --- a/docs/types/_standard_component_label.TJSSlotLabel-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_label.TJSSlotLabel-1.Props.html b/docs/types/_standard_component_label.TJSSlotLabel-1.Props.html deleted file mode 100644 index b2213e7..0000000 --- a/docs/types/_standard_component_label.TJSSlotLabel-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_label.TJSSlotLabel-1.Slots.html b/docs/types/_standard_component_label.TJSSlotLabel-1.Slots.html deleted file mode 100644 index fa69d55..0000000 --- a/docs/types/_standard_component_label.TJSSlotLabel-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_label.TJSToggleLabel-1.Events.html b/docs/types/_standard_component_label.TJSToggleLabel-1.Events.html deleted file mode 100644 index f5f15ee..0000000 --- a/docs/types/_standard_component_label.TJSToggleLabel-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_label.TJSToggleLabel-1.Props.html b/docs/types/_standard_component_label.TJSToggleLabel-1.Props.html deleted file mode 100644 index 07a29b3..0000000 --- a/docs/types/_standard_component_label.TJSToggleLabel-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        clickPropagate?: any;
                                                                                                                                                                                                                                                                                                                                                        comp?: any;
                                                                                                                                                                                                                                                                                                                                                        efx?: any;
                                                                                                                                                                                                                                                                                                                                                        enabled?: 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_label.TJSToggleLabel-1.Slots.html b/docs/types/_standard_component_label.TJSToggleLabel-1.Slots.html deleted file mode 100644 index 75698f9..0000000 --- a/docs/types/_standard_component_label.TJSToggleLabel-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_layer_position.TJSPositionControlLayer-1.Events.html b/docs/types/_standard_component_layer_position.TJSPositionControlLayer-1.Events.html deleted file mode 100644 index aea201d..0000000 --- a/docs/types/_standard_component_layer_position.TJSPositionControlLayer-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_layer_position.TJSPositionControlLayer-1.Props.html b/docs/types/_standard_component_layer_position.TJSPositionControlLayer-1.Props.html deleted file mode 100644 index ab36316..0000000 --- a/docs/types/_standard_component_layer_position.TJSPositionControlLayer-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_layer_position.TJSPositionControlLayer-1.Slots.html b/docs/types/_standard_component_layer_position.TJSPositionControlLayer-1.Slots.html deleted file mode 100644 index 84f575c..0000000 --- a/docs/types/_standard_component_layer_position.TJSPositionControlLayer-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_layer_side_slide.TJSSideSlideLayer-1.Events.html b/docs/types/_standard_component_layer_side_slide.TJSSideSlideLayer-1.Events.html deleted file mode 100644 index 6c70975..0000000 --- a/docs/types/_standard_component_layer_side_slide.TJSSideSlideLayer-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_layer_side_slide.TJSSideSlideLayer-1.Props.html b/docs/types/_standard_component_layer_side_slide.TJSSideSlideLayer-1.Props.html deleted file mode 100644 index 808d9e7..0000000 --- a/docs/types/_standard_component_layer_side_slide.TJSSideSlideLayer-1.Props.html +++ /dev/null @@ -1,21 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalside?: "left" | "right"

                                                                                                                                                                                                                                                                                                                                                      The side in layers parent element to display.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                          [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Additional inline styles to apply to the side slide layer. Useful for setting CSS variables.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      • [key: string]: string | null
                                                                                                                                                                                                                                                                                                                                                    • 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.

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

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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_layer_side_slide.TJSSideSlideLayer-1.Slots.html b/docs/types/_standard_component_layer_side_slide.TJSSideSlideLayer-1.Slots.html deleted file mode 100644 index 7d60930..0000000 --- a/docs/types/_standard_component_layer_side_slide.TJSSideSlideLayer-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_media.TJSMediaContent-1.Events.html b/docs/types/_standard_component_media.TJSMediaContent-1.Events.html deleted file mode 100644 index 360d127..0000000 --- a/docs/types/_standard_component_media.TJSMediaContent-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_media.TJSMediaContent-1.Props.html b/docs/types/_standard_component_media.TJSMediaContent-1.Props.html deleted file mode 100644 index efb8757..0000000 --- a/docs/types/_standard_component_media.TJSMediaContent-1.Props.html +++ /dev/null @@ -1,12 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        imgAlt?: string;
                                                                                                                                                                                                                                                                                                                                                        media?: object;
                                                                                                                                                                                                                                                                                                                                                        title?: string;
                                                                                                                                                                                                                                                                                                                                                        url?: string | URL;
                                                                                                                                                                                                                                                                                                                                                        urlDefault?: string | URL;
                                                                                                                                                                                                                                                                                                                                                        videoAutoplay?: boolean;
                                                                                                                                                                                                                                                                                                                                                        videoLoop?: boolean;
                                                                                                                                                                                                                                                                                                                                                        videoMuted?: boolean;
                                                                                                                                                                                                                                                                                                                                                        videoPlaybackRate?: number;
                                                                                                                                                                                                                                                                                                                                                        videoPlayOnHover?: boolean;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Props type alias for associated component.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • OptionalimgAlt?: string

                                                                                                                                                                                                                                                                                                                                                      Alternate image text.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalmedia?: object
                                                                                                                                                                                                                                                                                                                                                    • Optionaltitle?: string

                                                                                                                                                                                                                                                                                                                                                      A title for the media element.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalurl?: string | URL

                                                                                                                                                                                                                                                                                                                                                      URL path / URL for media content.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • OptionalurlDefault?: string | URL

                                                                                                                                                                                                                                                                                                                                                      Default URL path / URL for media content when no URL is configured.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • 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_media.TJSMediaContent-1.Slots.html b/docs/types/_standard_component_media.TJSMediaContent-1.Slots.html deleted file mode 100644 index a34da09..0000000 --- a/docs/types/_standard_component_media.TJSMediaContent-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_component_menu.TJSMenu-1.Events.html b/docs/types/_standard_component_menu.TJSMenu-1.Events.html deleted file mode 100644 index 930cf72..0000000 --- a/docs/types/_standard_component_menu.TJSMenu-1.Events.html +++ /dev/null @@ -1,3 +0,0 @@ -Events | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_menu.TJSMenu-1.Props.html b/docs/types/_standard_component_menu.TJSMenu-1.Props.html deleted file mode 100644 index 0a04e4e..0000000 --- a/docs/types/_standard_component_menu.TJSMenu-1.Props.html +++ /dev/null @@ -1,3 +0,0 @@ -Props | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Props

                                                                                                                                                                                                                                                                                                                                                    Props: {
                                                                                                                                                                                                                                                                                                                                                        efx?: Function;
                                                                                                                                                                                                                                                                                                                                                        focusEl?: HTMLElement | string;
                                                                                                                                                                                                                                                                                                                                                        items?: Iterable<TJSMenuItemData>;
                                                                                                                                                                                                                                                                                                                                                        keyCode?: string;
                                                                                                                                                                                                                                                                                                                                                        menu?: TJSMenuData;
                                                                                                                                                                                                                                                                                                                                                        offset?: {
                                                                                                                                                                                                                                                                                                                                                            x?: number;
                                                                                                                                                                                                                                                                                                                                                            y?: number;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        styles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        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_menu.TJSMenu-1.Slots.html b/docs/types/_standard_component_menu.TJSMenu-1.Slots.html deleted file mode 100644 index fa1feae..0000000 --- a/docs/types/_standard_component_menu.TJSMenu-1.Slots.html +++ /dev/null @@ -1,3 +0,0 @@ -Slots | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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_menu.TJSMenuData.html b/docs/types/_standard_component_menu.TJSMenuData.html index c9ced03..5431eba 100644 --- a/docs/types/_standard_component_menu.TJSMenuData.html +++ b/docs/types/_standard_component_menu.TJSMenuData.html @@ -1,15 +1,15 @@ -TJSMenuData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        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 +TJSMenuData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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?: { [key: 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.

                                                                                                                                                                                                                                                                                                                                                        +
                                                                                                                                                                                                                                                                                                                                                      • OptionalslotAfter?: { class: Function; props?: object }

                                                                                                                                                                                                                                                                                                                                                        A minimal Svelte config defining a menu item component after the main data driven menu items.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalslotBefore?: {
                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • OptionalslotDefault?: {
                                                                                                                                                                                                                                                                                                                                                            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.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Styles to be applied inline.

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                        • [key: string]: string | null
                                                                                                                                                                                                                                                                                                                                                      • OptionaltransitionOptions?: {
                                                                                                                                                                                                                                                                                                                                                            duration: number;
                                                                                                                                                                                                                                                                                                                                                            easing: EasingReference;
                                                                                                                                                                                                                                                                                                                                                        }

                                                                                                                                                                                                                                                                                                                                                        Custom transition options for duration and easing +

                                                                                                                                                                                                                                                                                                                                                      • Optionalstyles?: { [key: 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
                                                                                                                                                                                                                                                                                                                                                      \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_component_menu.TJSMenuItemData.html b/docs/types/_standard_component_menu.TJSMenuItemData.html index 20aedfe..429610f 100644 --- a/docs/types/_standard_component_menu.TJSMenuItemData.html +++ b/docs/types/_standard_component_menu.TJSMenuItemData.html @@ -1,13 +1,13 @@ -TJSMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSMenuItemData | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                      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.

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

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

                                                                                                                                                                                                                                                                                                                                                        -
                                                                                                                                                                                                                                                                                                                                                      • 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 +
                                                                                                                                                                                                                                                                                                                                                    • 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_store_fvtt_settings.TJSSettingsCreateOptions.html b/docs/types/_standard_store_fvtt_settings.TJSSettingsCreateOptions.html index a63a01d..a1141c6 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSSettingsCreateOptions.html +++ b/docs/types/_standard_store_fvtt_settings.TJSSettingsCreateOptions.html @@ -1,4 +1,4 @@ -TJSSettingsCreateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSSettingsCreateOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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/_standard_store_fvtt_settings.TJSSettingsCustomSection.html b/docs/types/_standard_store_fvtt_settings.TJSSettingsCustomSection.html index e30ec22..03338e6 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSSettingsCustomSection.html +++ b/docs/types/_standard_store_fvtt_settings.TJSSettingsCustomSection.html @@ -1,6 +1,6 @@ -TJSSettingsCustomSection | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +TJSSettingsCustomSection | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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/_standard_store_fvtt_settings.TJSSettingsCustomSectionFolder.html b/docs/types/_standard_store_fvtt_settings.TJSSettingsCustomSectionFolder.html index 4dc1120..bbb6b36 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSSettingsCustomSectionFolder.html +++ b/docs/types/_standard_store_fvtt_settings.TJSSettingsCustomSectionFolder.html @@ -1,5 +1,5 @@ -TJSSettingsCustomSectionFolder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSSettingsCustomSectionFolder

                                                                                                                                                                                                                                                                                                                                                    TJSSettingsCustomSectionFolder: {
                                                                                                                                                                                                                                                                                                                                                        label: string;
                                                                                                                                                                                                                                                                                                                                                        styles?: {
                                                                                                                                                                                                                                                                                                                                                            [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                        };
                                                                                                                                                                                                                                                                                                                                                        summaryEnd?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • label: string

                                                                                                                                                                                                                                                                                                                                                      The folder label.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalstyles?: {
                                                                                                                                                                                                                                                                                                                                                          [key: string]: string | null;
                                                                                                                                                                                                                                                                                                                                                      }

                                                                                                                                                                                                                                                                                                                                                      Inline styles for the TJSSvgFolder; useful for setting CSS variables.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                      • [key: string]: string | null
                                                                                                                                                                                                                                                                                                                                                    • OptionalsummaryEnd?: TJSSvelteConfig

                                                                                                                                                                                                                                                                                                                                                      A Svelte component config object defining TJSSvgFolder summary end component.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSSettingsCustomSectionFolder | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSSettingsCustomSectionFolder

                                                                                                                                                                                                                                                                                                                                                    TJSSettingsCustomSectionFolder: {
                                                                                                                                                                                                                                                                                                                                                        label: string;
                                                                                                                                                                                                                                                                                                                                                        styles?: { [key: string]: string };
                                                                                                                                                                                                                                                                                                                                                        summaryEnd?: TJSSvelteConfig;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • label: string

                                                                                                                                                                                                                                                                                                                                                      The folder label.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionalstyles?: { [key: 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/_standard_store_fvtt_settings.TJSSettingsUIData.html b/docs/types/_standard_store_fvtt_settings.TJSSettingsUIData.html index 88c03ea..d2f4aa6 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSSettingsUIData.html +++ b/docs/types/_standard_store_fvtt_settings.TJSSettingsUIData.html @@ -1,7 +1,7 @@ -TJSSettingsUIData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSSettingsUIData | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_store_fvtt_settings.TJSThemeStoreComponent.html b/docs/types/_standard_store_fvtt_settings.TJSThemeStoreComponent.html index a2a1cb3..cb05d39 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSThemeStoreComponent.html +++ b/docs/types/_standard_store_fvtt_settings.TJSThemeStoreComponent.html @@ -1,6 +1,6 @@ -TJSThemeStoreComponent | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • Optionalvar?: string

                                                                                                                                                                                                                                                                                                                                                      A CSS variable name.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSThemeStoreComponent | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • Optionalvar?: string

                                                                                                                                                                                                                                                                                                                                                      A CSS variable name.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/_standard_store_fvtt_settings.TJSThemeStoreConfig.html b/docs/types/_standard_store_fvtt_settings.TJSThemeStoreConfig.html index 7440e85..bfc7aec 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSThemeStoreConfig.html +++ b/docs/types/_standard_store_fvtt_settings.TJSThemeStoreConfig.html @@ -1,4 +1,4 @@ -TJSThemeStoreConfig | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSThemeStoreConfig

                                                                                                                                                                                                                                                                                                                                                    TJSThemeStoreConfig: {
                                                                                                                                                                                                                                                                                                                                                        components: Iterable<TJSThemeStoreComponent>;
                                                                                                                                                                                                                                                                                                                                                        version: string;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSThemeStoreConfig | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_fvtt_settings.TJSThemeStoreOptions.html b/docs/types/_standard_store_fvtt_settings.TJSThemeStoreOptions.html index 12d5595..9f838c0 100644 --- a/docs/types/_standard_store_fvtt_settings.TJSThemeStoreOptions.html +++ b/docs/types/_standard_store_fvtt_settings.TJSThemeStoreOptions.html @@ -1,7 +1,7 @@ -TJSThemeStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSThemeStoreOptions

                                                                                                                                                                                                                                                                                                                                                    TJSThemeStoreOptions: {
                                                                                                                                                                                                                                                                                                                                                        config: TJSThemeStoreConfig;
                                                                                                                                                                                                                                                                                                                                                        gameSettings: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                        key: string;
                                                                                                                                                                                                                                                                                                                                                        namespace: string;
                                                                                                                                                                                                                                                                                                                                                        styleManager: TJSStyleManager;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • config: TJSThemeStoreConfig

                                                                                                                                                                                                                                                                                                                                                      Data defining CSS theme store components and variables.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • gameSettings: TJSGameSettings

                                                                                                                                                                                                                                                                                                                                                      An associated TJSGameSettings instance.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • key: string

                                                                                                                                                                                                                                                                                                                                                      The world setting key.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • namespace: string

                                                                                                                                                                                                                                                                                                                                                      The world setting namespace.

                                                                                                                                                                                                                                                                                                                                                      -
                                                                                                                                                                                                                                                                                                                                                    • styleManager: TJSStyleManager

                                                                                                                                                                                                                                                                                                                                                      An associated TJSStyleManager instance to manipulate CSS variables.

                                                                                                                                                                                                                                                                                                                                                      -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +TJSThemeStoreOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias TJSThemeStoreOptions

                                                                                                                                                                                                                                                                                                                                                    TJSThemeStoreOptions: {
                                                                                                                                                                                                                                                                                                                                                        config: TJSThemeStoreConfig;
                                                                                                                                                                                                                                                                                                                                                        gameSettings: TJSGameSettings;
                                                                                                                                                                                                                                                                                                                                                        key: string;
                                                                                                                                                                                                                                                                                                                                                        namespace: string;
                                                                                                                                                                                                                                                                                                                                                        styleManager: TJSStyleManager;
                                                                                                                                                                                                                                                                                                                                                    }

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                    • config: TJSThemeStoreConfig

                                                                                                                                                                                                                                                                                                                                                      Data defining CSS theme store components and variables.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • gameSettings: TJSGameSettings

                                                                                                                                                                                                                                                                                                                                                      An associated TJSGameSettings instance.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • key: string

                                                                                                                                                                                                                                                                                                                                                      The world setting key.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • namespace: string

                                                                                                                                                                                                                                                                                                                                                      The world setting namespace.

                                                                                                                                                                                                                                                                                                                                                      +
                                                                                                                                                                                                                                                                                                                                                    • styleManager: TJSStyleManager

                                                                                                                                                                                                                                                                                                                                                      An associated TJSStyleManager instance to manipulate CSS variables.

                                                                                                                                                                                                                                                                                                                                                      +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/types/svelte.ComponentEvents.html b/docs/types/svelte.ComponentEvents.html index 3f9e4ff..8fee5bf 100644 --- a/docs/types/svelte.ComponentEvents.html +++ b/docs/types/svelte.ComponentEvents.html @@ -1,6 +1,6 @@ -ComponentEvents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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:

                                                                                                                                                                                                                                                                                                                                                    +ComponentEvents | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias ComponentEvents<Component>

                                                                                                                                                                                                                                                                                                                                                    ComponentEvents: 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 +

                                                                                                                                                                                                                                                                                                                                                    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 49f87ac..1b10ba5 100644 --- a/docs/types/svelte.ComponentProps.html +++ b/docs/types/svelte.ComponentProps.html @@ -1,6 +1,6 @@ -ComponentProps | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias ComponentProps<Component>

                                                                                                                                                                                                                                                                                                                                                    ComponentProps<Component>: Component extends SvelteComponent<infer Props>
                                                                                                                                                                                                                                                                                                                                                        ? Props
                                                                                                                                                                                                                                                                                                                                                        : never

                                                                                                                                                                                                                                                                                                                                                    Convenience type to get the props the given component expects. Example:

                                                                                                                                                                                                                                                                                                                                                    +ComponentProps | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias ComponentProps<Component>

                                                                                                                                                                                                                                                                                                                                                    ComponentProps: 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 +

                                                                                                                                                                                                                                                                                                                                                    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 8311b4d..e374095 100644 --- a/docs/types/svelte.ComponentType.html +++ b/docs/types/svelte.ComponentType.html @@ -1,9 +1,9 @@ -ComponentType | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +ComponentType | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias ComponentType<Component>

                                                                                                                                                                                                                                                                                                                                                    ComponentType: 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

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

                                                                                                                                                                                                                                                                                                                                                    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 3f7ce27..8e60807 100644 --- a/docs/types/svelte.NotFunction.html +++ b/docs/types/svelte.NotFunction.html @@ -1,3 +1,3 @@ -NotFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +NotFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias NotFunction<T>

                                                                                                                                                                                                                                                                                                                                                    NotFunction: 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 8d79c65..b089308 100644 --- a/docs/types/svelte_motion.Invalidator.html +++ b/docs/types/svelte_motion.Invalidator.html @@ -1,3 +1,3 @@ -Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                    Invalidator<T>: ((value?: T) => void)

                                                                                                                                                                                                                                                                                                                                                    Cleanup logic callback.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                    Invalidator: (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 a117394..49714ae 100644 --- a/docs/types/svelte_motion.Subscriber.html +++ b/docs/types/svelte_motion.Subscriber.html @@ -1,3 +1,3 @@ -Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Subscriber<T>

                                                                                                                                                                                                                                                                                                                                                    Subscriber: (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 4ac519c..114c03b 100644 --- a/docs/types/svelte_motion.Unsubscriber.html +++ b/docs/types/svelte_motion.Unsubscriber.html @@ -1,3 +1,3 @@ -Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Unsubscriber

                                                                                                                                                                                                                                                                                                                                                    Unsubscriber: (() => void)

                                                                                                                                                                                                                                                                                                                                                    Unsubscribes from value updates.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 facbf37..378bfc1 100644 --- a/docs/types/svelte_motion.Updater.html +++ b/docs/types/svelte_motion.Updater.html @@ -1,2 +1,2 @@ -Updater | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                    Updater<T>: ((target_value: T, value: T) => T)

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Updater | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                    Updater: (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 0f16d2c..5c12979 100644 --- a/docs/types/svelte_store.Invalidator.html +++ b/docs/types/svelte_store.Invalidator.html @@ -1,3 +1,3 @@ -Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                    Invalidator<T>: ((value?: T) => void)

                                                                                                                                                                                                                                                                                                                                                    Cleanup logic callback.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Invalidator | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Invalidator<T>

                                                                                                                                                                                                                                                                                                                                                    Invalidator: (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 ec19762..9aa6b00 100644 --- a/docs/types/svelte_store.StartStopNotifier.html +++ b/docs/types/svelte_store.StartStopNotifier.html @@ -1,8 +1,8 @@ -StartStopNotifier | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias StartStopNotifier<T>

                                                                                                                                                                                                                                                                                                                                                    StartStopNotifier<T>: ((set: ((value: T) => void), update: ((fn: Updater<T>) => void)) => void | (() => void))

                                                                                                                                                                                                                                                                                                                                                    Start and stop notification callbacks. +StartStopNotifier | TyphonJS Runtime Library (FVTT) 0.2.0

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias StartStopNotifier<T>

                                                                                                                                                                                                                                                                                                                                                    StartStopNotifier: (
                                                                                                                                                                                                                                                                                                                                                        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: 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 +

                                                                                                                                                                                                                                                                                                                                                    Type Parameters

                                                                                                                                                                                                                                                                                                                                                    • T

                                                                                                                                                                                                                                                                                                                                                    Type declaration

                                                                                                                                                                                                                                                                                                                                                      • (set: (value: T) => void, update: (fn: Updater<T>) => void): void | () => void

                                                                                                                                                                                                                                                                                                                                                      • Parameters

                                                                                                                                                                                                                                                                                                                                                        • set: (value: T) => void

                                                                                                                                                                                                                                                                                                                                                          Function that sets the value of the store.

                                                                                                                                                                                                                                                                                                                                                          +
                                                                                                                                                                                                                                                                                                                                                        • update: (fn: Updater<T>) => void

                                                                                                                                                                                                                                                                                                                                                          Function that sets the value of the store after passing the current value to the update function.

                                                                                                                                                                                                                                                                                                                                                          +

                                                                                                                                                                                                                                                                                                                                                        Returns void | () => void

                                                                                                                                                                                                                                                                                                                                                        Optionally, a cleanup function that is called when the last remaining subscriber unsubscribes.

                                                                                                                                                                                                                                                                                                                                                        -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ 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 3d4e214..a5edccc 100644 --- a/docs/types/svelte_store.Stores.html +++ b/docs/types/svelte_store.Stores.html @@ -1,3 +1,3 @@ -Stores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +Stores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 452118a..357687f 100644 --- a/docs/types/svelte_store.StoresValues.html +++ b/docs/types/svelte_store.StoresValues.html @@ -1,3 +1,3 @@ -StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +StoresValues | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias StoresValues<T>

                                                                                                                                                                                                                                                                                                                                                    StoresValues: 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 52e35b7..35e3946 100644 --- a/docs/types/svelte_store.Subscriber.html +++ b/docs/types/svelte_store.Subscriber.html @@ -1,3 +1,3 @@ -Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +Subscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Subscriber<T>

                                                                                                                                                                                                                                                                                                                                                    Subscriber: (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 ac1962a..33cf294 100644 --- a/docs/types/svelte_store.Unsubscriber.html +++ b/docs/types/svelte_store.Unsubscriber.html @@ -1,3 +1,3 @@ -Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias Unsubscriber

                                                                                                                                                                                                                                                                                                                                                    Unsubscriber: (() => void)

                                                                                                                                                                                                                                                                                                                                                    Unsubscribes from value updates.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +Unsubscriber | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 c519794..a03d4dc 100644 --- a/docs/types/svelte_store.Updater.html +++ b/docs/types/svelte_store.Updater.html @@ -1,3 +1,3 @@ -Updater | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +Updater | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Type Alias Updater<T>

                                                                                                                                                                                                                                                                                                                                                    Updater: (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 718463f..a7fa96c 100644 --- a/docs/types/svelte_transition.EasingFunction.html +++ b/docs/types/svelte_transition.EasingFunction.html @@ -1,2 +1,2 @@ -EasingFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Type Alias EasingFunction

                                                                                                                                                                                                                                                                                                                                                    EasingFunction: ((t: number) => number)

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +EasingFunction | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 839caa3..4c8ce02 100644 --- a/docs/variables/_runtime_data_compress.FlateErrorCode.html +++ b/docs/variables/_runtime_data_compress.FlateErrorCode.html @@ -1,3 +1,3 @@ -FlateErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +FlateErrorCode | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 899f112..9931971 100644 --- a/docs/variables/_runtime_data_format_base64.Base64.html +++ b/docs/variables/_runtime_data_format_base64.Base64.html @@ -1,2 +1,2 @@ -Base64 | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 +Base64 | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 689656d..119f026 100644 --- a/docs/variables/_runtime_data_format_base64.VERSION.html +++ b/docs/variables/_runtime_data_format_base64.VERSION.html @@ -1,8 +1,8 @@ -version | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable versionConst

                                                                                                                                                                                                                                                                                                                                                    version: "3.7.7" = '3.7.7'

                                                                                                                                                                                                                                                                                                                                                    base64.ts

                                                                                                                                                                                                                                                                                                                                                    +version | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 +

                                                                                                                                                                                                                                                                                                                                                    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 cffbd1a..112291d 100644 --- a/docs/variables/_runtime_data_format_base64.version-1.html +++ b/docs/variables/_runtime_data_format_base64.version-1.html @@ -1,3 +1,3 @@ -VERSION | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable VERSIONConst

                                                                                                                                                                                                                                                                                                                                                    VERSION: "3.7.7" = '3.7.7'

                                                                                                                                                                                                                                                                                                                                                    Deprecated

                                                                                                                                                                                                                                                                                                                                                    use lowercase version.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +VERSION | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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 77eec8b..cacf5af 100644 --- a/docs/variables/_runtime_data_format_msgpack.C1.html +++ b/docs/variables/_runtime_data_format_msgpack.C1.html @@ -1,2 +1,2 @@ -C1 | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable C1Const

                                                                                                                                                                                                                                                                                                                                                    C1: {}

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +C1 | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable C1Const

                                                                                                                                                                                                                                                                                                                                                    C1: {}

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_msgpack.RESERVE_START_SPACE.html b/docs/variables/_runtime_data_format_msgpack.RESERVE_START_SPACE.html index 1745a32..0caa19d 100644 --- a/docs/variables/_runtime_data_format_msgpack.RESERVE_START_SPACE.html +++ b/docs/variables/_runtime_data_format_msgpack.RESERVE_START_SPACE.html @@ -1,2 +1,2 @@ -RESERVE_START_SPACE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable RESERVE_START_SPACEConst

                                                                                                                                                                                                                                                                                                                                                    RESERVE_START_SPACE: number

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +RESERVE_START_SPACE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable RESERVE_START_SPACEConst

                                                                                                                                                                                                                                                                                                                                                    RESERVE_START_SPACE: number

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_msgpack.RESET_BUFFER_MODE.html b/docs/variables/_runtime_data_format_msgpack.RESET_BUFFER_MODE.html index 7f44f3b..f3f4601 100644 --- a/docs/variables/_runtime_data_format_msgpack.RESET_BUFFER_MODE.html +++ b/docs/variables/_runtime_data_format_msgpack.RESET_BUFFER_MODE.html @@ -1,2 +1,2 @@ -RESET_BUFFER_MODE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable RESET_BUFFER_MODEConst

                                                                                                                                                                                                                                                                                                                                                    RESET_BUFFER_MODE: number

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +RESET_BUFFER_MODE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable RESET_BUFFER_MODEConst

                                                                                                                                                                                                                                                                                                                                                    RESET_BUFFER_MODE: number

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/variables/_runtime_data_format_msgpack.REUSE_BUFFER_MODE.html b/docs/variables/_runtime_data_format_msgpack.REUSE_BUFFER_MODE.html index 5ed86ea..4e10cf5 100644 --- a/docs/variables/_runtime_data_format_msgpack.REUSE_BUFFER_MODE.html +++ b/docs/variables/_runtime_data_format_msgpack.REUSE_BUFFER_MODE.html @@ -1,2 +1,2 @@ -REUSE_BUFFER_MODE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable REUSE_BUFFER_MODEConst

                                                                                                                                                                                                                                                                                                                                                    REUSE_BUFFER_MODE: number

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +REUSE_BUFFER_MODE | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable REUSE_BUFFER_MODEConst

                                                                                                                                                                                                                                                                                                                                                    REUSE_BUFFER_MODE: number

                                                                                                                                                                                                                                                                                                                                                    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 e081ff5..5464bb5 100644 --- a/docs/variables/_runtime_data_format_msgpack.isNativeAccelerationEnabled.html +++ b/docs/variables/_runtime_data_format_msgpack.isNativeAccelerationEnabled.html @@ -1,2 +1,2 @@ -isNativeAccelerationEnabled | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable isNativeAccelerationEnabled

                                                                                                                                                                                                                                                                                                                                                    isNativeAccelerationEnabled: boolean

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +isNativeAccelerationEnabled | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable isNativeAccelerationEnabled

                                                                                                                                                                                                                                                                                                                                                    isNativeAccelerationEnabled: boolean

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_animate_gsap.gsap.html b/docs/variables/_runtime_svelte_animate_gsap.gsap.html index 97c93aa..c82cbd2 100644 --- a/docs/variables/_runtime_svelte_animate_gsap.gsap.html +++ b/docs/variables/_runtime_svelte_animate_gsap.gsap.html @@ -1,4 +1,4 @@ -gsap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable gsap

                                                                                                                                                                                                                                                                                                                                                    gsap: any

                                                                                                                                                                                                                                                                                                                                                    The main GSAP object.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    See

                                                                                                                                                                                                                                                                                                                                                    https://greensock.com/docs/v3/GSAP

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +gsap | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_animate_gsap.gsapEasingFunc.html b/docs/variables/_runtime_svelte_animate_gsap.gsapEasingFunc.html index 3a652c9..7d21f75 100644 --- a/docs/variables/_runtime_svelte_animate_gsap.gsapEasingFunc.html +++ b/docs/variables/_runtime_svelte_animate_gsap.gsapEasingFunc.html @@ -1,5 +1,5 @@ -gsapEasingFunc | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable gsapEasingFuncConst

                                                                                                                                                                                                                                                                                                                                                    gsapEasingFunc: Readonly<{
                                                                                                                                                                                                                                                                                                                                                        [key in GsapEasingFunctionName]: 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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable gsapEasingFuncConst

                                                                                                                                                                                                                                                                                                                                                    gsapEasingFunc: Readonly<{ [key in GsapEasingFunctionName]: 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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file diff --git a/docs/variables/_runtime_svelte_animate_gsap.gsapEasingList.html b/docs/variables/_runtime_svelte_animate_gsap.gsapEasingList.html index d945069..6bb6310 100644 --- a/docs/variables/_runtime_svelte_animate_gsap.gsapEasingList.html +++ b/docs/variables/_runtime_svelte_animate_gsap.gsapEasingList.html @@ -1,5 +1,5 @@ -gsapEasingList | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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

                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +

                                                                                                                                                                                                                                                                                                                                                    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 2290b94..0f7f893 100644 --- a/docs/variables/_runtime_svelte_easing.easingFunc.html +++ b/docs/variables/_runtime_svelte_easing.easingFunc.html @@ -1,2 +1,2 @@ -easingFunc | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable easingFuncConst

                                                                                                                                                                                                                                                                                                                                                    easingFunc: Readonly<{
                                                                                                                                                                                                                                                                                                                                                        [key in EasingFunctionName]: EasingFunction
                                                                                                                                                                                                                                                                                                                                                    }>

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +easingFunc | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable easingFuncConst

                                                                                                                                                                                                                                                                                                                                                    easingFunc: Readonly<{ [key in 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 44555c5..4cccd2b 100644 --- a/docs/variables/_runtime_svelte_easing.easingList.html +++ b/docs/variables/_runtime_svelte_easing.easingList.html @@ -1,3 +1,3 @@ -easingList | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable easingListConst

                                                                                                                                                                                                                                                                                                                                                    easingList: Readonly<EasingFunctionName[]>

                                                                                                                                                                                                                                                                                                                                                    Defines a read-only list of Svelte easing function names.

                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +easingList | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    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_store_web_storage.localStores.html b/docs/variables/_runtime_svelte_store_web_storage.localStores.html deleted file mode 100644 index 9dbbdc9..0000000 --- a/docs/variables/_runtime_svelte_store_web_storage.localStores.html +++ /dev/null @@ -1,3 +0,0 @@ -localStores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 9ada82b..0000000 --- a/docs/variables/_runtime_svelte_store_web_storage.sessionStores.html +++ /dev/null @@ -1,3 +0,0 @@ -sessionStores | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index fa9784b..0000000 --- a/docs/variables/_runtime_svelte_store_web_storage_msgpack.localStoresBCMP.html +++ /dev/null @@ -1,3 +0,0 @@ -localStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 deleted file mode 100644 index 3823ba9..0000000 --- a/docs/variables/_runtime_svelte_store_web_storage_msgpack.sessionStoresBCMP.html +++ /dev/null @@ -1,3 +0,0 @@ -sessionStoresBCMP | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    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 diff --git a/docs/variables/_runtime_util_html_striptags.DefaultStateMachineOptions.html b/docs/variables/_runtime_util_html_striptags.DefaultStateMachineOptions.html index 2d77a50..929e6b8 100644 --- a/docs/variables/_runtime_util_html_striptags.DefaultStateMachineOptions.html +++ b/docs/variables/_runtime_util_html_striptags.DefaultStateMachineOptions.html @@ -1,2 +1,2 @@ -DefaultStateMachineOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    -

                                                                                                                                                                                                                                                                                                                                                    Variable DefaultStateMachineOptionsConst

                                                                                                                                                                                                                                                                                                                                                    DefaultStateMachineOptions: StateMachineOptions

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file +DefaultStateMachineOptions | TyphonJS Runtime Library (FVTT) 0.2.0
                                                                                                                                                                                                                                                                                                                                                    +

                                                                                                                                                                                                                                                                                                                                                    Variable DefaultStateMachineOptionsConst

                                                                                                                                                                                                                                                                                                                                                    DefaultStateMachineOptions: StateMachineOptions

                                                                                                                                                                                                                                                                                                                                                    Settings

                                                                                                                                                                                                                                                                                                                                                    Member Visibility
                                                                                                                                                                                                                                                                                                                                                    \ No newline at end of file